orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
OrxString

Macros

#define orxSTRING_KC_VECTOR_END   ')'
#define orxSTRING_KC_VECTOR_END_ALT   '}'
#define orxSTRING_KC_VECTOR_SEPARATOR   ','
#define orxSTRING_KC_VECTOR_START   '('
#define orxSTRING_KC_VECTOR_START_ALT   '{'
#define orxString_ToCRC   orxString_Hash
#define STRTO_CAST   (int)

Functions

static orxINLINE orxS32 orxString_Compare (const orxSTRING _zString1, const orxSTRING _zString2)
static orxINLINE orxSTATUS orxString_Delete (orxSTRING _zString)
static orxINLINE orxSTRING orxString_Duplicate (const orxSTRING _zSrcString)
orxDLLAPI orxSTATUS orxFASTCALL orxString_Erase (orxSTRINGID _stID)
orxDLLAPI void orxFASTCALL orxString_Exit ()
static orxINLINE orxU32 orxString_ExtractBase (const orxSTRING _zString, const orxSTRING *_pzRemaining)
static orxINLINE orxU32 orxString_GetCharacterCount (const orxSTRING _zString)
static orxINLINE orxU32 orxString_GetEditDistance (const orxSTRING _zString1, const orxSTRING _zString2)
static orxINLINE const orxSTRING orxString_GetExtension (const orxSTRING _zFileName)
static orxU32 orxFASTCALL orxString_GetFirstCharacterCodePoint (const orxSTRING _zString, const orxSTRING *_pzRemaining)
orxDLLAPI const orxSTRING orxFASTCALL orxString_GetFromID (orxSTRINGID _stID)
orxDLLAPI orxSTRINGID orxFASTCALL orxString_GetID (const orxSTRING _zString)
static orxINLINE orxU32 orxString_GetLength (const orxSTRING _zString)
static orxINLINE orxU32 orxString_GetUTF8CharacterLength (orxU32 _u32CharacterCodePoint)
orxDLLAPI orxSTRINGID orxFASTCALL orxString_Hash (const orxSTRING _zString)
static orxINLINE orxS32 orxString_ICompare (const orxSTRING _zString1, const orxSTRING _zString2)
orxDLLAPI orxSTATUS orxFASTCALL orxString_Init ()
static orxINLINE orxBOOL orxString_IsCharacterAlphaNumeric (orxU32 _u32CharacterCodePoint)
static orxINLINE orxBOOL orxString_IsCharacterASCII (orxU32 _u32CharacterCodePoint)
static orxINLINE orxSTRING orxString_LowerCase (orxSTRING _zString)
static orxINLINE orxS32 orxString_NCompare (const orxSTRING _zString1, const orxSTRING _zString2, orxU32 _u32CharNumber)
static orxINLINE orxSTRING orxString_NCopy (orxSTRING _zDstString, const orxSTRING _zSrcString, orxU32 _u32CharNumber)
orxDLLAPI orxSTRINGID orxFASTCALL orxString_NHash (const orxSTRING _zString, orxU32 _u32CharNumber)
static orxINLINE orxS32 orxString_NICompare (const orxSTRING _zString1, const orxSTRING _zString2, orxU32 _u32CharNumber)
static orxINLINE orxS32 orxCDECL orxString_NPrint (orxSTRING _zDstString, orxU32 _u32CharNumber, const orxSTRING _zSrcString,...)
static orxU32 orxFASTCALL orxString_PrintUTF8Character (orxSTRING _zDstString, orxU32 _u32Size, orxU32 _u32CharacterCodePoint)
static orxINLINE orxS32 orxCDECL orxString_Scan (const orxSTRING _zString, const orxSTRING _zFormat,...)
static orxINLINE const orxSTRING orxString_SearchChar (const orxSTRING _zString, orxCHAR _cChar)
static orxINLINE orxS32 orxString_SearchCharIndex (const orxSTRING _zString, orxCHAR _cChar, orxS32 _s32Position)
static orxINLINE const orxSTRING orxString_SearchString (const orxSTRING _zString1, const orxSTRING _zString2)
orxDLLAPI void orxFASTCALL orxString_Setup ()
static orxINLINE const orxSTRING orxString_SkipPath (const orxSTRING _zString)
static orxINLINE const orxSTRING orxString_SkipWhiteSpaces (const orxSTRING _zString)
orxDLLAPI const orxSTRING orxFASTCALL orxString_Store (const orxSTRING _zString)
static orxINLINE orxSTATUS orxString_ToBool (const orxSTRING _zString, orxBOOL *_pbOutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToFloat (const orxSTRING _zString, orxFLOAT *_pfOutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToS32 (const orxSTRING _zString, orxS32 *_ps32OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToS32Base (const orxSTRING _zString, orxU32 _u32Base, orxS32 *_ps32OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToS64 (const orxSTRING _zString, orxS64 *_ps64OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToS64Base (const orxSTRING _zString, orxU32 _u32Base, orxS64 *_ps64OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToU32 (const orxSTRING _zString, orxU32 *_pu32OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToU32Base (const orxSTRING _zString, orxU32 _u32Base, orxU32 *_pu32OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToU64 (const orxSTRING _zString, orxU64 *_pu64OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToU64Base (const orxSTRING _zString, orxU32 _u32Base, orxU64 *_pu64OutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTATUS orxString_ToVector (const orxSTRING _zString, orxVECTOR *_pvOutValue, const orxSTRING *_pzRemaining)
static orxINLINE orxSTRING orxString_UpperCase (orxSTRING _zString)

Detailed Description

String module Module that handles strings

Macro Definition Documentation

◆ orxSTRING_KC_VECTOR_END

#define orxSTRING_KC_VECTOR_END   ')'

Definition at line 80 of file orxString.h.

◆ orxSTRING_KC_VECTOR_END_ALT

#define orxSTRING_KC_VECTOR_END_ALT   '}'

Definition at line 81 of file orxString.h.

◆ orxSTRING_KC_VECTOR_SEPARATOR

#define orxSTRING_KC_VECTOR_SEPARATOR   ','

Definition at line 79 of file orxString.h.

◆ orxSTRING_KC_VECTOR_START

#define orxSTRING_KC_VECTOR_START   '('

Definition at line 77 of file orxString.h.

◆ orxSTRING_KC_VECTOR_START_ALT

#define orxSTRING_KC_VECTOR_START_ALT   '{'

Definition at line 78 of file orxString.h.

◆ orxString_ToCRC

#define orxString_ToCRC   orxString_Hash

Defines

Definition at line 86 of file orxString.h.

◆ STRTO_CAST

#define STRTO_CAST   (int)

Definition at line 74 of file orxString.h.

Function Documentation

◆ orxString_Compare()

orxINLINE orxS32 orxString_Compare ( const orxSTRING _zString1,
const orxSTRING _zString2 )
static

Compares two strings (case sensitive)

Parameters
[in]_zString1First String to compare
[in]_zString2Second string to compare
Returns
-1 if _zString1 < _zString2, 0 if _zString1 == _zString2, 1 if _zString1 > _zString2

Definition at line 603 of file orxString.h.

◆ orxString_Delete()

orxINLINE orxSTATUS orxString_Delete ( orxSTRING _zString)
static

Deletes a string

Parameters
[in]_zStringString to delete
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 585 of file orxString.h.

◆ orxString_Duplicate()

orxINLINE orxSTRING orxString_Duplicate ( const orxSTRING _zSrcString)
static

Duplicates a string.

Parameters
[in]_zSrcStringString to duplicate
Returns
The duplicated string

Definition at line 556 of file orxString.h.

◆ orxString_Erase()

orxDLLAPI orxSTATUS orxFASTCALL orxString_Erase ( orxSTRINGID _stID)
extern

Erases an internal string: this is intended for orx's internal use, do not call unless you know what you're doing

Parameters
[in]_stIDConcerned string ID
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxString_Exit()

orxDLLAPI void orxFASTCALL orxString_Exit ( )
extern

Exits from the structure module

◆ orxString_ExtractBase()

orxINLINE orxU32 orxString_ExtractBase ( const orxSTRING _zString,
const orxSTRING * _pzRemaining )
static

Extracts the base (2, 8, 10 or 16) from a literal number

Parameters
[in]_zStringString from which to extract the base
[out]_pzRemainingIf non null, it will contain the remaining number literal, right after the base prefix (0x, 0b or 0) if any
Returns
The base or the numerical value, defaults to 10 (decimal) when no prefix is found or the literal value couldn't be identified

Definition at line 766 of file orxString.h.

◆ orxString_GetCharacterCount()

orxINLINE orxU32 orxString_GetCharacterCount ( const orxSTRING _zString)
static

Gets the number of valid unicode characters (UTF-8) in the string (for ASCII string, it will be the same result as orxString_GetLength())

Parameters
[in]_zStringConcerned string
Returns
The number of valid unicode characters contained in the string, orxU32_UNDEFINED for an invalid UTF-8 string

Definition at line 507 of file orxString.h.

◆ orxString_GetEditDistance()

orxINLINE orxU32 orxString_GetEditDistance ( const orxSTRING _zString1,
const orxSTRING _zString2 )
static

Gets the edit distance (Damerau-Levenshtein) between two strings

Parameters
[in]_zString1First string
[in]_zString2Second string
Returns
The edit distance between both strings

Definition at line 684 of file orxString.h.

◆ orxString_GetExtension()

orxINLINE const orxSTRING orxString_GetExtension ( const orxSTRING _zFileName)
static

Gets the extension of a file name

Parameters
[in]_zFileNameConcerned file name
Returns
Extension if present, orxSTRING_EMPTY otherwise

Definition at line 1532 of file orxString.h.

◆ orxString_GetFirstCharacterCodePoint()

orxU32 orxFASTCALL orxString_GetFirstCharacterCodePoint ( const orxSTRING _zString,
const orxSTRING * _pzRemaining )
static

Gets the unicode code point of the first character of the UTF-8 string

Parameters
[in]_zStringConcerned string
[out]_pzRemainingIf non null, it will contain the remaining string after the first UTF-8 character
Returns
The code of the first UTF-8 character of the string, orxU32_UNDEFINED if it's an invalid character

Definition at line 340 of file orxString.h.

◆ orxString_GetFromID()

orxDLLAPI const orxSTRING orxFASTCALL orxString_GetFromID ( orxSTRINGID _stID)
extern

Gets a string from an ID (it should have already been stored internally with a call to orxString_GetID)

Parameters
[in]_stIDConcerned string ID
Returns
orxSTRING if ID's found, orxSTRING_EMPTY otherwise

◆ orxString_GetID()

orxDLLAPI orxSTRINGID orxFASTCALL orxString_GetID ( const orxSTRING _zString)
extern

Gets a string's ID (and stores the string internally to prevent duplication)

Parameters
[in]_zStringConcerned string
Returns
String's ID

◆ orxString_GetLength()

orxINLINE orxU32 orxString_GetLength ( const orxSTRING _zString)
static

Gets the number of orxCHAR in the string (for non-ASCII UTF-8 string, it won't be the actual number of unicode characters)

Parameters
[in]_zStringString used for length computation
Returns
The length of the string (doesn't include the final orxCHAR_NULL character)

Definition at line 171 of file orxString.h.

◆ orxString_GetUTF8CharacterLength()

orxINLINE orxU32 orxString_GetUTF8CharacterLength ( orxU32 _u32CharacterCodePoint)
static

Gets the UTF-8 encoding length of a given character

Parameters
[in]_u32CharacterCodePointConcerned character code
Returns
The encoding length in UTF-8 for the given character if valid, orxU32_UNDEFINED otherwise

Definition at line 206 of file orxString.h.

◆ orxString_Hash()

orxDLLAPI orxSTRINGID orxFASTCALL orxString_Hash ( const orxSTRING _zString)
extern

Gets a string's ID (aka hash), without storing the string internally

Parameters
[in]_zStringConcerned string
Returns
String's ID/hash

◆ orxString_ICompare()

orxINLINE orxS32 orxString_ICompare ( const orxSTRING _zString1,
const orxSTRING _zString2 )
static

Compares two strings (case insensitive)

Parameters
[in]_zString1First String to compare
[in]_zString2Second string to compare
Returns
-1 if _zString1 < _zString2, 0 if _zString1 == _zString2, 1 if _zString1 > _zString2

Definition at line 635 of file orxString.h.

◆ orxString_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxString_Init ( )
extern

Initializess the structure module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxString_IsCharacterAlphaNumeric()

orxINLINE orxBOOL orxString_IsCharacterAlphaNumeric ( orxU32 _u32CharacterCodePoint)
static

Tells if a character is alpha-numeric from its ID

Parameters
[in]_u32CharacterCodePointConcerned character code
Returns
orxTRUE is it's a non-extended ASCII alpha-numerical character, orxFALSE otherwise

Definition at line 194 of file orxString.h.

◆ orxString_IsCharacterASCII()

orxINLINE orxBOOL orxString_IsCharacterASCII ( orxU32 _u32CharacterCodePoint)
static

Tells if a character is ASCII from its ID

Parameters
[in]_u32CharacterCodePointConcerned character code
Returns
orxTRUE is it's a non-extended ASCII character, orxFALSE otherwise

Definition at line 184 of file orxString.h.

◆ orxString_LowerCase()

orxINLINE orxSTRING orxString_LowerCase ( orxSTRING _zString)
static

Converts a string to lower case

Parameters
[in]_zStringString To convert
Returns
The converted string

Definition at line 1354 of file orxString.h.

◆ orxString_NCompare()

orxINLINE orxS32 orxString_NCompare ( const orxSTRING _zString1,
const orxSTRING _zString2,
orxU32 _u32CharNumber )
static

Compares the N first characters of two strings (case sensitive) and 0 if they are equals.

Parameters
[in]_zString1First String to compare
[in]_zString2Second string to compare
[in]_u32CharNumberNumber of character to compare
Returns
-1 if _zString1 < _zString2, 0 if _zString1 == _zString2, 1 if _zString1 > _zString2

Definition at line 620 of file orxString.h.

◆ orxString_NCopy()

orxINLINE orxSTRING orxString_NCopy ( orxSTRING _zDstString,
const orxSTRING _zSrcString,
orxU32 _u32CharNumber )
static

Copies up to N characters from a string

Parameters
[in]_zDstStringDestination string
[in]_zSrcStringSource string
[in]_u32CharNumberNumber of characters to copy
Returns
The copied string

Definition at line 541 of file orxString.h.

◆ orxString_NHash()

orxDLLAPI orxSTRINGID orxFASTCALL orxString_NHash ( const orxSTRING _zString,
orxU32 _u32CharNumber )
extern

Gets a string's ID (aka hash), without storing the string internally

Parameters
[in]_zStringConcerned string
[in]_u32CharNumberNumber of character to process, should be <= orxString_GetLength(_zString)
Returns
String's ID/hash

◆ orxString_NICompare()

orxINLINE orxS32 orxString_NICompare ( const orxSTRING _zString1,
const orxSTRING _zString2,
orxU32 _u32CharNumber )
static

Compare the N first characters of two strings (case insensitive)

Parameters
[in]_zString1First String to compare
[in]_zString2Second string to compare
[in]_u32CharNumberNumber of character to compare
Returns
-1 if _zString1 < _zString2, 0 if _zString1 == _zString2, 1 if _zString1 > _zString2

Definition at line 660 of file orxString.h.

◆ orxString_NPrint()

orxINLINE orxS32 orxCDECL orxString_NPrint ( orxSTRING _zDstString,
orxU32 _u32CharNumber,
const orxSTRING _zSrcString,
... )
static

Prints a formatted string to a memory buffer using a max size

Parameters
[out]_zDstStringDestination string
[in]_u32CharNumberMax number of character to print, including the terminating null character
[in]_zSrcStringSource formatted string
Returns
The number of written characters, excluding the terminating null character

Definition at line 1469 of file orxString.h.

◆ orxString_PrintUTF8Character()

orxU32 orxFASTCALL orxString_PrintUTF8Character ( orxSTRING _zDstString,
orxU32 _u32Size,
orxU32 _u32CharacterCodePoint )
static

Prints a unicode character encoded with UTF-8 to an orxSTRING

Parameters
[in]_zDstStringDestination string
[in]_u32SizeAvailable size on the string
[in]_u32CharacterCodePointUnicode code point of the character to print
Returns
The length of the encoded UTF-8 character (1, 2, 3 or 4) if valid, orxU32_UNDEFINED otherwise

Definition at line 247 of file orxString.h.

◆ orxString_Scan()

orxINLINE orxS32 orxCDECL orxString_Scan ( const orxSTRING _zString,
const orxSTRING _zFormat,
... )
static

Scans a formatted string from a memory buffer

Parameters
[in]_zStringString to scan
[in]_zFormatFormat string
Returns
The number of scanned items

Definition at line 1508 of file orxString.h.

◆ orxString_SearchChar()

orxINLINE const orxSTRING orxString_SearchChar ( const orxSTRING _zString,
orxCHAR _cChar )
static

Finds the first occurrence of _cChar in _zString

Parameters
[in]_zStringString to analyze
[in]_cCharThe character to find
Returns
The pointer of the first occurrence of _cChar, or orxNULL if not found

Definition at line 1422 of file orxString.h.

◆ orxString_SearchCharIndex()

orxINLINE orxS32 orxString_SearchCharIndex ( const orxSTRING _zString,
orxCHAR _cChar,
orxS32 _s32Position )
static

Finds the first occurrence of _cChar in _zString

Parameters
[in]_zStringString to analyze
[in]_cCharThe character to find
[in]_s32PositionSearch begin position
Returns
The index of the next occurrence of requested character, starting at given position / -1 if not found

Definition at line 1437 of file orxString.h.

◆ orxString_SearchString()

orxINLINE const orxSTRING orxString_SearchString ( const orxSTRING _zString1,
const orxSTRING _zString2 )
static

Finds the first occurrence of _zString2 in _zString1

Parameters
[in]_zString1String to analyze
[in]_zString2The string to find inside _zString1
Returns
The pointer of the first occurrence of _zString2, or orxNULL if not found

Definition at line 1407 of file orxString.h.

◆ orxString_Setup()

orxDLLAPI void orxFASTCALL orxString_Setup ( )
extern

Structure module setup

◆ orxString_SkipPath()

orxINLINE const orxSTRING orxString_SkipPath ( const orxSTRING _zString)
static

Skips path

Parameters
[in]_zStringConcerned string
Returns
The sub-string located after all non-terminal directory separators

Definition at line 128 of file orxString.h.

◆ orxString_SkipWhiteSpaces()

orxINLINE const orxSTRING orxString_SkipWhiteSpaces ( const orxSTRING _zString)
static

Skips all white spaces

Parameters
[in]_zStringConcerned string
Returns
The sub-string located after all leading white spaces, including EOL characters

Definition at line 96 of file orxString.h.

◆ orxString_Store()

orxDLLAPI const orxSTRING orxFASTCALL orxString_Store ( const orxSTRING _zString)
extern

Stores a string internally: equivalent to an optimized call to orxString_GetFromID(orxString_GetID(_zString))

Parameters
[in]_zStringConcerned string
Returns
Stored orxSTRING

◆ orxString_ToBool()

orxINLINE orxSTATUS orxString_ToBool ( const orxSTRING _zString,
orxBOOL * _pbOutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a boolean

Parameters
[in]_zStringString To convert
[out]_pbOutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the boolean conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1281 of file orxString.h.

◆ orxString_ToFloat()

orxINLINE orxSTATUS orxString_ToFloat ( const orxSTRING _zString,
orxFLOAT * _pfOutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a value

Parameters
[in]_zStringString To convert
[out]_pfOutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1129 of file orxString.h.

◆ orxString_ToS32()

orxINLINE orxSTATUS orxString_ToS32 ( const orxSTRING _zString,
orxS32 * _ps32OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a signed int value, guessing the base

Parameters
[in]_zStringString To convert
[out]_ps32OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 899 of file orxString.h.

◆ orxString_ToS32Base()

orxINLINE orxSTATUS orxString_ToS32Base ( const orxSTRING _zString,
orxU32 _u32Base,
orxS32 * _ps32OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a signed int value using the given base

Parameters
[in]_zStringString To convert
[in]_u32BaseBase of the read value (generally 10, but can be 16 to read hexa)
[out]_ps32OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 858 of file orxString.h.

◆ orxString_ToS64()

orxINLINE orxSTATUS orxString_ToS64 ( const orxSTRING _zString,
orxS64 * _ps64OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a signed int value, guessing the base

Parameters
[in]_zStringString To convert
[out]_ps64OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1035 of file orxString.h.

◆ orxString_ToS64Base()

orxINLINE orxSTATUS orxString_ToS64Base ( const orxSTRING _zString,
orxU32 _u32Base,
orxS64 * _ps64OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a signed int value using the given base

Parameters
[in]_zStringString To convert
[in]_u32BaseBase of the read value (generally 10, but can be 16 to read hexa)
[out]_ps64OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 994 of file orxString.h.

◆ orxString_ToU32()

orxINLINE orxSTATUS orxString_ToU32 ( const orxSTRING _zString,
orxU32 * _pu32OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to an unsigned int value, guessing the base

Parameters
[in]_zStringString To convert
[out]_pu32OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 967 of file orxString.h.

◆ orxString_ToU32Base()

orxINLINE orxSTATUS orxString_ToU32Base ( const orxSTRING _zString,
orxU32 _u32Base,
orxU32 * _pu32OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to an unsigned int value using the given base

Parameters
[in]_zStringString To convert
[in]_u32BaseBase of the read value (generally 10, but can be 16 to read hexa)
[out]_pu32OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 926 of file orxString.h.

◆ orxString_ToU64()

orxINLINE orxSTATUS orxString_ToU64 ( const orxSTRING _zString,
orxU64 * _pu64OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to an unsigned int value, guessing the base

Parameters
[in]_zStringString To convert
[out]_pu64OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1103 of file orxString.h.

◆ orxString_ToU64Base()

orxINLINE orxSTATUS orxString_ToU64Base ( const orxSTRING _zString,
orxU32 _u32Base,
orxU64 * _pu64OutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to an unsigned int value using the given base

Parameters
[in]_zStringString To convert
[in]_u32BaseBase of the read value (generally 10, but can be 16 to read hexa)
[out]_pu64OutValueConverted value
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1062 of file orxString.h.

◆ orxString_ToVector()

orxINLINE orxSTATUS orxString_ToVector ( const orxSTRING _zString,
orxVECTOR * _pvOutValue,
const orxSTRING * _pzRemaining )
static

Converts a string to a vector

Parameters
[in]_zStringString To convert
[out]_pvOutValueConverted value. N.B.: if only two components (x, y) are defined, the z component will be set to zero
[out]_pzRemainingIf non null, it will contain the remaining string after the number conversion
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Definition at line 1180 of file orxString.h.

◆ orxString_UpperCase()

orxINLINE orxSTRING orxString_UpperCase ( orxSTRING _zString)
static

Converts a string to upper case

Parameters
[in]_zStringString To convert
Returns
The converted string

Definition at line 1380 of file orxString.h.

Generated for orx by doxygen 1.8.11