Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
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.
Syntax
typedef struct varstring_tag { DWORD dwTotalSize; DWORD dwNeededSize; DWORD dwUsedSize; DWORD dwStringFormat; DWORD dwStringSize; DWORD dwStringOffset; } VARSTRING, FAR* LPVARSTRING; |
Members
- 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.
Remarks
No extensibility.
If a string cannot be returned in a variable structure, the dwStringSizeand dwStringOffsetmembers are set in one of these ways:
-
dwStringSizeand
dwStringOffsetmembers are both set to zero.
-
dwStringOffsetis nonzero and
dwStringSizeis zero.
-
dwStringOffsetis nonzero,
dwStringSizeis 1, and the byte at the given offset is zero.
Requirements
Header | tapi.h |
Windows Embedded CE | Windows CE 1.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |