Edit

Share via

WS_XML_STRING structure (webservices.h)

  • Article

Represents a string that optionally has dictionary information associated with it. The xml APIs use WS_XML_STRINGs to identify prefixes, localNames and namespaces.

Syntax

typedef struct _WS_XML_STRING {
  ULONG             length;
  BYTE              *bytes;
  WS_XML_DICTIONARY *dictionary;
  ULONG             id;
} WS_XML_STRING;

Members

length

The number of bytes in the UTF-8 encoded representation of the string.

bytes

The string encoded as UTF-8 bytes.

dictionary

A pointer to the dictionary that contains the string. If the string is not part of a dictionary then the value may be NULL.

id

A value that uniquely identifies the string within the specified dictionary. The entry at dictionary->strings[id] should identify this string.

If the dictionary is NULL, then this value is unused.

Remarks

The string is represented as UTF-8 encoded bytes, not WCHARs. It is not required to be zero terminated.

The macros WS_XML_STRING_VALUE, WS_XML_STRING_NULL and WS_XML_STRING_DICTIONARY_VALUE can be used to initialize this structure.

The dictionary information is used by the binary encoding to write a more compact xml document.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Header webservices.h