5.1.1.15 VARSTRING

The VARSTRING structure is used for returning variable sized strings. It is used both by the line device class and the phone device class.

typedef struct varstring_tag {

DWORD dwTotalSize;

DWORD dwNeededSize;

DWORD dwUsedSize;

DWORD dwStringFormat;

DWORD dwStringSize;

DWORD dwStringOffset;

} VARSTRING, FAR *LPVARSTRING;

Fields

The VARSTRING structure contains the following fields:

dwTotalSize
The total size in bytes allocated to this data structure.

DwNeededSize
The size in bytes for this data structure that is needed to hold all the returned information.

DwUsedSize
The size in bytes of this data structure that contains useful information.
The size in bytes and the offset in bytes from the beginning of the containing data structure of a variable sized field.

DwStringFormat
Specifies the format of the string, of type STRINGFORMAT. Values are:

STRINGFORMAT_ASCII
This is ASCII string format using one byte per character.

STRINGFORMAT_DBCS
This is DBCS string format using two bytes per character.

STRINGFORMAT_UNICODE
This is unicode string format using two bytes per character.

STRINGFORMAT_BINARY
This is an array of unsigned characters; could be used for numeric values.

DwStringSize
dwStringOffset
The size in bytes and the offset in bytes from the beginning of this data structure of the variable sized device field containing the string information.

Extensibility

None.

Comments

None.

See Also

Data Types: STRINGFORMAT