ADTF  3.13.0
IStringabstract

The IString interface provides methods for getting and setting strings through abstract interfaces. More...

Inheritance diagram for IString:
[legend]

Public Member Functions

virtual tResult Set (const tChar *strValue)=0
 Sets the given null-terminated string to the implementation. More...
 
virtual const tCharGet () const =0
 Gets the pointer to the current associated nullterminated-string. More...
 
virtual tSize GetLength () const =0
 Gets the current size of the strng. More...
 

Static Public Attributes

static constexpr tSize InvalidPos = g_npos
 Invalid Position size.
 

Detailed Description

The IString interface provides methods for getting and setting strings through abstract interfaces.

See adtf_string if you want to forward your own string type.

Definition at line 23 of file string_intf.h.

Member Function Documentation

◆ Get()

virtual const tChar* Get ( ) const
pure virtual

Gets the pointer to the current associated nullterminated-string.

Returns
The pointer to the null-terminated string.
Remarks
Check the pointer, because it depends on the implementation of IString!

Implemented in adtf_string< T >, and cQtIStringImpl.

Referenced by property_value< ::adtf::base::ant::property_attached_configuration_type >::FromString().

◆ GetLength()

virtual tSize GetLength ( ) const
pure virtual

Gets the current size of the strng.

Usually this is in Bytes (null-termination is not included!)

Returns
The size of the string.
Return values
Ifnot valid return InvalidPos!

Implemented in adtf_string< T >, and cQtIStringImpl.

◆ Set()

virtual tResult Set ( const tChar strValue)
pure virtual

Sets the given null-terminated string to the implementation.

Parameters
strValue[in] The null-terminated string to set.
Return values
ERR_NOERRORThe value is set successfully
ERR_MEMORYThe value can not be set. Too long. No truncating provided.

Implemented in adtf_string< T >, and cQtIStringImpl.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Sep 28 2021 by doxygen 1.8.14)