VARSTRING

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;

Members

  • dwTotalSize
    Specifies the total size, in bytes, allocated to this data structure.

  • dwNeededSize
    Specifies the size, in bytes, for this data structure that is needed to hold all the returned data.

  • dwUsedSize
    Specifies the size, in bytes, of the portion of this data structure that contains useful data.

  • dwStringFormat
    Specifies the format of the string. This member uses the following STRINGFORMAT_ constants:

    Value Description
    STRINGFORMAT_ASCII ASCII string format using one byte per character. The actual string is a NULL-terminated ASCII string with the terminating NULL accounted for in the string size.
    STRINGFORMAT_DBCS DBCS string format using one or two bytes per character.
    STRINGFORMAT_UNICODE Unicode string format using two bytes per character.
    STRINGFORMAT_BINARY An array of unsigned characters that could be used for numeric values.
  • dwStringSize
    dwStringOffset
    Specify the size, in bytes, of the variably sized device field that contains the string data, and the offset, in bytes, from the beginning of this data structure.

Remarks

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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Tapi.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

lineConfigDialogEdit, lineGetDevConfig, lineGetID, lineSetDevConfig, LINECALLPARAMS

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.