Classes | |
union | valueunion |
struct | valuedescr |
Typedefs | |
typedef union valueunion | ValueUnion |
typedef struct valuedescr | ValueDescr |
Enumerations | |
enum | FormatType : UInt32 { FMT_NONE = 0, FMT_ARRAY = 0x80000000, FMT_SHORT = 2, FMT_LONG = 3, FMT_DPFP = 4, FMT_DOUBLE = FMT_DPFP, FMT_BYTE = 5, FMT_RAD5 = 9, FMT_UWORD = 10, FMT_USHORT = FMT_UWORD, FMT_UINT = 11, FMT_ULONG = FMT_UINT, FMT_LONG64 = 16, FMT_TIME = 17, FMT_VOIDP = 18, FMT_WCHAR = 19, FMT_ULONG64 = 20, FMT_BOOL = 21, FMT_MIN = FMT_NONE, FMT_MAX = FMT_BOOL } |
Functions | |
StatusInt | mdlValueDescr_init (ValueDescr *pDescr) |
Initializes / Clears a ValueDescr. More... | |
int | mdlValueDescr_compare (ValueDescr const *pDescr1, ValueDescr const *pDescr2) |
Compares two ValueDescrs. More... | |
int | mdlValueDescr_compareN (ValueDescr const *pDescr1, ValueDescr const *pDescr2, size_t iMaxChars) |
Compares two ValueDescrs for a certain number of characters. More... | |
int | mdlValueDescr_compareI (ValueDescr const *pDescr1, ValueDescr const *pDescr2) |
Compares two ValueDescrs, ignoring case of string values. More... | |
int | mdlValueDescr_compareNI (ValueDescr const *pDescr1, ValueDescr const *pDescr2, size_t iMaxChars, bool bIgnoreCase) |
Compares two ValueDescrs for a certain number of characters, ignoring case of string values. More... | |
StatusInt | mdlValueDescr_copy (ValueDescr *pDescrTarget, ValueDescr const *pDescrSource, bool bPointerOnly) |
Makes a copy of a ValueDescr. More... | |
StatusInt | mdlValueDescr_copyFromOffset (ValueDescr *pDescrTarget, ValueDescr const *pDescrSource, int iOffset, bool bPointerOnly) |
Makes a copy of a ValueDescr beginning at a specified offset. More... | |
StatusInt | mdlValueDescr_copyN (ValueDescr *pDescrTarget, ValueDescr const *pDescrSource, size_t iMaxChars) |
Makes a copy of a ValueDescr up to a maximum of characters, copying a character string into the provided buffer. More... | |
StatusInt | mdlValueDescr_dup (ValueDescr *pDescrTarget, ValueDescr const *pDescrSource) |
Makes a duplicate of ValueDescr. More... | |
StatusInt | mdlValueDescr_dupN (ValueDescr *pDescrTarget, ValueDescr const *pDescrSource, size_t iMaxChars) |
Makes a copy of ValueDescr up to a maximum of characters. More... | |
StatusInt | mdlValueDescr_freeStringValue (ValueDescr *pDescr) |
Frees the string value in a ValueDescr. More... | |
bool | mdlValueDescr_isSeparator (ValueDescr const *pDescr, bool bOnlyOneChar) |
Determines whether the ValueDescr value indicates a separator row ('-' or "-") More... | |
bool | mdlValueDescr_isPlacemark (ValueDescr const *pDescr, bool bOnlyOneChar) |
Determines whether the ValueDescr value indicates a placemark row ('^' or "^") More... | |
int | mdlValueDescr_getStringNChars (ValueDescr const *pDescr) |
Returns the number of characters in a string value. More... | |
int | mdlValueDescr_getStringNBytes (ValueDescr const *pDescr) |
Returns the number of bytes in a string value. More... | |
int | mdlValueDescr_getStringDrawLength (ValueDescr const *pDescr) |
Returns the length of the string used in drawing routines. More... | |
StatusInt | mdlValueDescr_getWString (WStringR wString, ValueDescr const *pDescr) |
Retrieves a string value as a WString given a ValueDescr. More... | |
StatusInt | mdlValueDescr_getWStringFromValueUnion (WStringR wString, FormatType formatType, ValueUnion *pValueUnion) |
Retrieves a string value as a WString given a format type and ValueUnion. More... | |
bool | mdlValueDescr_isNumeric (ValueDescr const *pDescr) |
Determines whether the ValueDescr value contains a numeric value. More... | |
bool | mdlValueDescr_isSigned (ValueDescr const *pDescr) |
Determines whether the ValueDescr value contains a signed numeric value. More... | |
bool | mdlValueDescr_isUnsigned (ValueDescr const *pDescr) |
Determines whether the ValueDescr value contains an unsigned numeric value. More... | |
typedef struct valuedescr ValueDescr |
typedef union valueunion ValueUnion |
enum FormatType : UInt32 |
int mdlValueDescr_compare | ( | ValueDescr const * | pDescr1, |
ValueDescr const * | pDescr2 | ||
) |
Compares two ValueDescrs.
[in] | pDescr1 | pointer to 1st ValueDescr to compare |
[in] | pDescr2 | pointer to 2nd ValueDescr to compare |
int mdlValueDescr_compareI | ( | ValueDescr const * | pDescr1, |
ValueDescr const * | pDescr2 | ||
) |
Compares two ValueDescrs, ignoring case of string values.
[in] | pDescr1 | pointer to 1st ValueDescr to compare |
[in] | pDescr2 | pointer to 2nd ValueDescr to compare |
int mdlValueDescr_compareN | ( | ValueDescr const * | pDescr1, |
ValueDescr const * | pDescr2, | ||
size_t | iMaxChars | ||
) |
Compares two ValueDescrs for a certain number of characters.
[in] | pDescr1 | pointer to 1st ValueDescr to compare |
[in] | pDescr2 | pointer to 2nd ValueDescr to compare |
[in] | iMaxChars | number of chars to compare |
int mdlValueDescr_compareNI | ( | ValueDescr const * | pDescr1, |
ValueDescr const * | pDescr2, | ||
size_t | iMaxChars, | ||
bool | bIgnoreCase | ||
) |
Compares two ValueDescrs for a certain number of characters, ignoring case of string values.
[in] | pDescr1 | pointer to 1st ValueDescr to compare |
[in] | pDescr2 | pointer to 2nd ValueDescr to compare |
[in] | iMaxChars | number of chars to compare |
[in] | bIgnoreCase | true = ignore case when comparing string values |
StatusInt mdlValueDescr_copy | ( | ValueDescr * | pDescrTarget, |
ValueDescr const * | pDescrSource, | ||
bool | bPointerOnly | ||
) |
Makes a copy of a ValueDescr.
If the value is a string pointer, this function either copies the string into the provided buffer or sets the target pointer.
[in,out] | pDescrTarget | pointer to target ValueDescr |
[in] | pDescrSource | pointer to source ValueDescr to copy |
[in] | bPointerOnly | true = if pointer value, copy the pointer & not the data |
StatusInt mdlValueDescr_copyFromOffset | ( | ValueDescr * | pDescrTarget, |
ValueDescr const * | pDescrSource, | ||
int | iOffset, | ||
bool | bPointerOnly | ||
) |
Makes a copy of a ValueDescr beginning at a specified offset.
This function either copies a character string into the provided buffer or sets the target pointer.
[in,out] | pDescrTarget | pointer to target ValueDescr |
[in] | pDescrSource | pointer to source ValueDescr to copy |
[in] | iOffset | if value is a string, copy the source beginning at this offset |
[in] | bPointerOnly | true = if pointer value, copy the pointer & not the data |
StatusInt mdlValueDescr_copyN | ( | ValueDescr * | pDescrTarget, |
ValueDescr const * | pDescrSource, | ||
size_t | iMaxChars | ||
) |
Makes a copy of a ValueDescr up to a maximum of characters, copying a character string into the provided buffer.
[in,out] | pDescrTarget | pointer to target ValueDescr |
[in] | pDescrSource | pointer to source ValueDescr to copy |
[in] | iMaxChars | maximum number of characters to copy |
StatusInt mdlValueDescr_dup | ( | ValueDescr * | pDescrTarget, |
ValueDescr const * | pDescrSource | ||
) |
Makes a duplicate of ValueDescr.
The receiving buffer is allocated. The caller must free it by calling mdlValueDescr_freeStringValue.
[in,out] | pDescrTarget | pointer to target ValueDescr |
[in] | pDescrSource | pointer to source ValueDescr to duplicates |
StatusInt mdlValueDescr_dupN | ( | ValueDescr * | pDescrTarget, |
ValueDescr const * | pDescrSource, | ||
size_t | iMaxChars | ||
) |
Makes a copy of ValueDescr up to a maximum of characters.
The receiving buffer is allocated. The caller must free it by calling mdlValueDescr_freeStringValue.
[in,out] | pDescrTarget | pointer to target ValueDescr |
[in] | pDescrSource | pointer to source ValueDescr to duplicate |
[in] | iMaxChars | maximum number of characters to duplicate |
StatusInt mdlValueDescr_freeStringValue | ( | ValueDescr * | pDescr | ) |
Frees the string value in a ValueDescr.
[in] | pDescr | ValueDescr containing string value to free |
int mdlValueDescr_getStringDrawLength | ( | ValueDescr const * | pDescr | ) |
Returns the length of the string used in drawing routines.
[in] | pDescr | ValueDescr containing a string value |
int mdlValueDescr_getStringNBytes | ( | ValueDescr const * | pDescr | ) |
Returns the number of bytes in a string value.
[in] | pDescr | ValueDescr containing a string value |
int mdlValueDescr_getStringNChars | ( | ValueDescr const * | pDescr | ) |
Returns the number of characters in a string value.
[in] | pDescr | ValueDescr containing a string value |
StatusInt mdlValueDescr_getWString | ( | WStringR | wString, |
ValueDescr const * | pDescr | ||
) |
Retrieves a string value as a WString given a ValueDescr.
[out] | wString | WString receiving the string value |
[in] | pDescr | ValueDescr containing a string value |
StatusInt mdlValueDescr_getWStringFromValueUnion | ( | WStringR | wString, |
FormatType | formatType, | ||
ValueUnion * | pValueUnion | ||
) |
Retrieves a string value as a WString given a format type and ValueUnion.
[out] | wString | WString receiving the string value |
[in] | formatType | format type of the value in the ValueUnion |
[in] | pValueUnion | ValueUnion containing the string value |
StatusInt mdlValueDescr_init | ( | ValueDescr * | pDescr | ) |
Initializes / Clears a ValueDescr.
[in] | pDescr | ValueDescr to initialize |
bool mdlValueDescr_isNumeric | ( | ValueDescr const * | pDescr | ) |
Determines whether the ValueDescr value contains a numeric value.
[in] | pDescr | ValueDescr possibly containing placemark value |
bool mdlValueDescr_isPlacemark | ( | ValueDescr const * | pDescr, |
bool | bOnlyOneChar | ||
) |
Determines whether the ValueDescr value indicates a placemark row ('^' or "^")
[in] | pDescr | ValueDescr possibly containing placemark value |
[in] | bOnlyOneChar | true if value must be only one '^'; false if start with '^' |
bool mdlValueDescr_isSeparator | ( | ValueDescr const * | pDescr, |
bool | bOnlyOneChar | ||
) |
Determines whether the ValueDescr value indicates a separator row ('-' or "-")
[in] | pDescr | ValueDescr possibly containing separator value |
[in] | bOnlyOneChar | true if value must be only one '-'; false if start with '-' |
bool mdlValueDescr_isSigned | ( | ValueDescr const * | pDescr | ) |
Determines whether the ValueDescr value contains a signed numeric value.
[in] | pDescr | ValueDescr possibly containing placemark value |
bool mdlValueDescr_isUnsigned | ( | ValueDescr const * | pDescr | ) |
Determines whether the ValueDescr value contains an unsigned numeric value.
[in] | pDescr | ValueDescr possibly containing placemark value |