Classes | Typedefs | Enumerations | Functions
ValueDescriptors

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...
 

Detailed Description

Typedef Documentation

typedef struct valuedescr ValueDescr
typedef union valueunion ValueUnion

Enumeration Type Documentation

Enumerator
FMT_NONE 
FMT_ARRAY 
FMT_SHORT 
FMT_LONG 
FMT_DPFP 
FMT_DOUBLE 
FMT_BYTE 
FMT_RAD5 
FMT_UWORD 
FMT_USHORT 
FMT_UINT 
FMT_ULONG 
FMT_LONG64 
FMT_TIME 
FMT_VOIDP 
FMT_WCHAR 
FMT_ULONG64 
FMT_BOOL 
FMT_MIN 
FMT_MAX 

Function Documentation

int mdlValueDescr_compare ( ValueDescr const *  pDescr1,
ValueDescr const *  pDescr2 
)

Compares two ValueDescrs.

Parameters
[in]pDescr1pointer to 1st ValueDescr to compare
[in]pDescr2pointer to 2nd ValueDescr to compare
Remarks
Required Library: mdlbltin.lib
Returns
0 if equal, -1 if *pDescr1 < *pDescr2, 1 if *pDescr1 > *pDescr2
int mdlValueDescr_compareI ( ValueDescr const *  pDescr1,
ValueDescr const *  pDescr2 
)

Compares two ValueDescrs, ignoring case of string values.

Parameters
[in]pDescr1pointer to 1st ValueDescr to compare
[in]pDescr2pointer to 2nd ValueDescr to compare
Returns
0 if equal, -1 if *pDescr1 < *pDescr2, 1 if *pDescr1 > *pDescr2
Remarks
Required Library: mdlbltin.lib
int mdlValueDescr_compareN ( ValueDescr const *  pDescr1,
ValueDescr const *  pDescr2,
size_t  iMaxChars 
)

Compares two ValueDescrs for a certain number of characters.

Parameters
[in]pDescr1pointer to 1st ValueDescr to compare
[in]pDescr2pointer to 2nd ValueDescr to compare
[in]iMaxCharsnumber of chars to compare
Remarks
Required Library: mdlbltin.lib
Returns
0 if equal, -1 if *pDescr1 < *pDescr2, 1 if *pDescr1 > *pDescr2
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.

Parameters
[in]pDescr1pointer to 1st ValueDescr to compare
[in]pDescr2pointer to 2nd ValueDescr to compare
[in]iMaxCharsnumber of chars to compare
[in]bIgnoreCasetrue = ignore case when comparing string values
Remarks
Required Library: mdlbltin.lib
Returns
0 if equal, -1 if *pDescr1 < *pDescr2, 1 if *pDescr1 > *pDescr2
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.

Parameters
[in,out]pDescrTargetpointer to target ValueDescr
[in]pDescrSourcepointer to source ValueDescr to copy
[in]bPointerOnlytrue = if pointer value, copy the pointer & not the data
Remarks
Required Library: mdlbltin.lib
Returns
SUCCESS if copy succeeded, ERROR if either pointer is bad
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.

Parameters
[in,out]pDescrTargetpointer to target ValueDescr
[in]pDescrSourcepointer to source ValueDescr to copy
[in]iOffsetif value is a string, copy the source beginning at this offset
[in]bPointerOnlytrue = if pointer value, copy the pointer & not the data
Remarks
Required Library: mdlbltin.lib
Returns
SUCCESS if copy succeeded, ERROR if either pointer is bad
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.

Parameters
[in,out]pDescrTargetpointer to target ValueDescr
[in]pDescrSourcepointer to source ValueDescr to copy
[in]iMaxCharsmaximum number of characters to copy
Returns
SUCCESS if copy succeeded, ERROR if either pointer is bad
Remarks
Required Library: mdlbltin.lib
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.

Parameters
[in,out]pDescrTargetpointer to target ValueDescr
[in]pDescrSourcepointer to source ValueDescr to duplicates
Returns
SUCCESS if copy succeeded, ERROR if either pointer is bad
Remarks
Required Library: mdlbltin.lib
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.

Parameters
[in,out]pDescrTargetpointer to target ValueDescr
[in]pDescrSourcepointer to source ValueDescr to duplicate
[in]iMaxCharsmaximum number of characters to duplicate
Returns
SUCCESS if copy succeeded, ERROR if either pointer is bad
Remarks
Required Library: mdlbltin.lib
StatusInt mdlValueDescr_freeStringValue ( ValueDescr pDescr)

Frees the string value in a ValueDescr.

Parameters
[in]pDescrValueDescr containing string value to free
Returns
SUCCESS if free succeeded, ERROR if pointer is bad
Remarks
Required Library: mdlbltin.lib
int mdlValueDescr_getStringDrawLength ( ValueDescr const *  pDescr)

Returns the length of the string used in drawing routines.

Parameters
[in]pDescrValueDescr containing a string value
Returns
Length of the string used in drawing routines
Remarks
Required Library: mdlbltin.lib
int mdlValueDescr_getStringNBytes ( ValueDescr const *  pDescr)

Returns the number of bytes in a string value.

Parameters
[in]pDescrValueDescr containing a string value
Returns
Number of bytes in the string
Remarks
Required Library: mdlbltin.lib
int mdlValueDescr_getStringNChars ( ValueDescr const *  pDescr)

Returns the number of characters in a string value.

Parameters
[in]pDescrValueDescr containing a string value
Returns
Number of characters in the string
Remarks
Required Library: mdlbltin.lib
StatusInt mdlValueDescr_getWString ( WStringR  wString,
ValueDescr const *  pDescr 
)

Retrieves a string value as a WString given a ValueDescr.

Parameters
[out]wStringWString receiving the string value
[in]pDescrValueDescr containing a string value
Returns
Length of the string used in drawing routines
Remarks
Required Library: mdlbltin.lib
StatusInt mdlValueDescr_getWStringFromValueUnion ( WStringR  wString,
FormatType  formatType,
ValueUnion pValueUnion 
)

Retrieves a string value as a WString given a format type and ValueUnion.

Parameters
[out]wStringWString receiving the string value
[in]formatTypeformat type of the value in the ValueUnion
[in]pValueUnionValueUnion containing the string value
Returns
Length of the string used in drawing routines
Remarks
Required Library: mdlbltin.lib
StatusInt mdlValueDescr_init ( ValueDescr pDescr)

Initializes / Clears a ValueDescr.

Parameters
[in]pDescrValueDescr to initialize
Returns
SUCCESS if copy succeeded, ERROR if pointer is bad
Remarks
Required Library: mdlbltin.lib
bool mdlValueDescr_isNumeric ( ValueDescr const *  pDescr)

Determines whether the ValueDescr value contains a numeric value.

Parameters
[in]pDescrValueDescr possibly containing placemark value
Returns
true if the ValueDescr value contains a numeric value; false if not
Remarks
Required Library: mdlbltin.lib
bool mdlValueDescr_isPlacemark ( ValueDescr const *  pDescr,
bool  bOnlyOneChar 
)

Determines whether the ValueDescr value indicates a placemark row ('^' or "^")

Parameters
[in]pDescrValueDescr possibly containing placemark value
[in]bOnlyOneChartrue if value must be only one '^'; false if start with '^'
Returns
true if placemark row; false if not
Remarks
Required Library: mdlbltin.lib
bool mdlValueDescr_isSeparator ( ValueDescr const *  pDescr,
bool  bOnlyOneChar 
)

Determines whether the ValueDescr value indicates a separator row ('-' or "-")

Parameters
[in]pDescrValueDescr possibly containing separator value
[in]bOnlyOneChartrue if value must be only one '-'; false if start with '-'
Returns
true if separator row; false if not
Remarks
Required Library: mdlbltin.lib
bool mdlValueDescr_isSigned ( ValueDescr const *  pDescr)

Determines whether the ValueDescr value contains a signed numeric value.

Parameters
[in]pDescrValueDescr possibly containing placemark value
Returns
true if the ValueDescr value contains a signed numeric value; false if not
Remarks
Required Library: mdlbltin.lib
bool mdlValueDescr_isUnsigned ( ValueDescr const *  pDescr)

Determines whether the ValueDescr value contains an unsigned numeric value.

Parameters
[in]pDescrValueDescr possibly containing placemark value
Returns
true if the ValueDescr value contains an unsigned numeric value; false if not
Remarks
Required Library: mdlbltin.lib

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.