VARSTRING

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This structure is used for returning variably 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;

dwTotalSize

Total size, in bytes, allocated to this data structure.

dwNeededSize

Size, in bytes, for this data structure that is needed to hold all the returned data.

dwUsedSize

Size, in bytes, of the portion of this data structure that contains useful data.

dwStringFormat

Value that specifies the format of the string. This member uses STRINGFORMAT.

dwStringSize

Size, in bytes, of the variably sized device field that contains the string data.

dwStringOffset

Offset, in bytes, from the beginning of this data structure.

No extensibility.

If a string cannot be returned in a variable structure, the dwStringSize and dwStringOffset members are set in one of these ways:

  • dwStringSize and dwStringOffset members are both set to zero.
  • dwStringOffset is nonzero and dwStringSize is zero.
  • dwStringOffset is nonzero, dwStringSize is 1, and the byte at the given offset is zero.

Headertapi.h
Windows Embedded CEWindows CE 1.0 and later
Windows MobileWindows Mobile Version 5.0 and later
Show: