VAR_STRING (Compact 2013)
3/26/2014
This structure is an object-specific structured information buffer. More than one of these TAPI structures has a member of type VAR_STRING, which is also a structured buffer.
Syntax
typedef struct _VAR_STRING {
ULONG ulTotalSize;
ULONG ulNeededSize;
ULONG ulUsedSize;
ULONG ulStringFormat;
ULONG ulStringSize;
ULONG ulStringOffset;
} VAR_STRING, *PVAR_STRING;
Members
- ulTotalSize
The total size in bytes of the buffer, including the buffered string.
- ulNeededSize
The size in bytes of a buffer necessary to contain a particular string. For example, the underlying driver sets this value if a protocol-supplied buffer is too short to contain a requested string.
- ulUsedSize
The number of bytes in the given buffer that were actually used.
ulStringFormat
Specifies how the buffered string should be interpreted, as one of the following:- STRINGFORMAT_ASCII
- STRINGFORMAT_DBCS
- STRINGFORMAT_UNICODE
- STRINGFORMAT_BINARY
- ulStringSize
The number of bytes in the given buffered string.
- ulStringOffset
The offset within this buffer at which the string begins.
Remarks
TAPI query information requests differ from set information requests in that one or more members in the associated structure, denoted by the OUT prefix in the structure definition, are reserved for information the underlying miniport driver should return to the initiator of the request. WAN network adapter drivers should treat structure members prefixed with "IN" as read-only.
The first member of all the structures used in query-information requests, ulRequestID, is reserved. Miniport drivers should ignore this member.
WAN miniport drivers return no information for set requests other than the completion status. The protocol driver provides all object-specific structures, and their members are read-only to the underlying WAN miniport driver.
Requirements
Header |
ndistapi.h, |
See Also
Reference
NDIS 5.x Legacy Structures
MiniportSetInformation
NdisMIndicateStatus
NDIS_TAPI_GET_DEV_CONFIG
NDIS_TAPI_GET_ID
NDIS_TAPI_SET_DEV_CONFIG
NDIS 5.x Legacy Reference