ADTF
Loading...
Searching...
No Matches
adtf_string_forward< const char >

Specialisation for const char pointer. More...

#include <string_intf.h>

Static Public Member Functions

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

Detailed Description

Specialisation for const char pointer.

Definition at line 168 of file string_intf.h.

Member Function Documentation

◆ GetConstChar() [1/4]

static const char * GetConstChar ( const char *const pValue)
inlinestatic

Definition at line 170 of file string_intf.h.

◆ GetConstChar() [2/4]

static const char * GetConstChar ( const const char *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 72 of file string_intf.h.

◆ GetConstChar() [3/4]

static const char * GetConstChar ( const const char *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 72 of file string_intf.h.

◆ GetConstChar() [4/4]

static const char * GetConstChar ( const const char *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 72 of file string_intf.h.

◆ GetCurrentLength() [1/4]

static size_t GetCurrentLength ( const char *const pValue)
inlinestatic

Definition at line 174 of file string_intf.h.

◆ GetCurrentLength() [2/4]

static size_t GetCurrentLength ( const const char *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 84 of file string_intf.h.

◆ GetCurrentLength() [3/4]

static size_t GetCurrentLength ( const const char *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 84 of file string_intf.h.

◆ GetCurrentLength() [4/4]

static size_t GetCurrentLength ( const const char *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 84 of file string_intf.h.

◆ SetValue() [1/4]

static tResult SetValue ( const char *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 101 of file string_intf.h.

◆ SetValue() [2/4]

static tResult SetValue ( const char *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 101 of file string_intf.h.

◆ SetValue() [3/4]

static tResult SetValue ( const char *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 101 of file string_intf.h.

◆ SetValue() [4/4]

static tResult SetValue ( const char * const ,
const char *  )
inlinestatic

Definition at line 178 of file string_intf.h.