ADTF  3.14.3
adtf_string_forward< std::string >

Specialisation for std::string class. More...

Static Public Member Functions

static const char * GetConstChar (const std::string *const pValue)
 Retrieves a const char pointer (null-terminated). More...
 
static size_t GetCurrentLength (const std::string *const pValue)
 Retrieves the string size of the given pValue. More...
 
static tResult SetValue (std::string *const pValue, const char *strValue)
 Sets the given strValue to the string type implementation of the given pValue. More...
 

Detailed Description

Specialisation for std::string class.

Definition at line 91 of file string_intf.h.

Member Function Documentation

◆ GetConstChar()

static const char* GetConstChar ( const std::string *const  pValue)
inlinestatic

Retrieves a const char pointer (null-terminated).

Parameters
pValue[in] Pointer to string implementation.
Returns
the pointer to a const char* nullterminated string out of pValue
Remarks
The return value is only valid as long as pValue is alive.

Definition at line 94 of file string_intf.h.

◆ GetCurrentLength()

static size_t GetCurrentLength ( const std::string *const  pValue)
inlinestatic

Retrieves the string size of the given pValue.

Parameters
pValue[in] Pointer to string implementation.
Returns
size of the string (char count without null-terminated value)

Definition at line 99 of file string_intf.h.

◆ SetValue()

static tResult SetValue ( std::string *const  pValue,
const char *  strValue 
)
inlinestatic

Sets the given strValue to the string type implementation of the given pValue.

Parameters
pValue[in] Pointer to string implementation.
strValue[in] value to set.
Returns
Depends on implementation.
Return values
ERR_ACCESS_DENIEDwriting access denied, value can not be set.
ERR_MEMORYstrValue size exceeds the buffer of pValue.
ERR_NOERRORSuccessfully set.

Definition at line 104 of file string_intf.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)