WS_TYPE enumeration (webservices.h)
The types supported for serialization.
Syntax
typedef enum {
WS_BOOL_TYPE = 0,
WS_INT8_TYPE = 1,
WS_INT16_TYPE = 2,
WS_INT32_TYPE = 3,
WS_INT64_TYPE = 4,
WS_UINT8_TYPE = 5,
WS_UINT16_TYPE = 6,
WS_UINT32_TYPE = 7,
WS_UINT64_TYPE = 8,
WS_FLOAT_TYPE = 9,
WS_DOUBLE_TYPE = 10,
WS_DECIMAL_TYPE = 11,
WS_DATETIME_TYPE = 12,
WS_TIMESPAN_TYPE = 13,
WS_GUID_TYPE = 14,
WS_UNIQUE_ID_TYPE = 15,
WS_STRING_TYPE = 16,
WS_WSZ_TYPE = 17,
WS_BYTES_TYPE = 18,
WS_XML_STRING_TYPE = 19,
WS_XML_QNAME_TYPE = 20,
WS_XML_BUFFER_TYPE = 21,
WS_CHAR_ARRAY_TYPE = 22,
WS_UTF8_ARRAY_TYPE = 23,
WS_BYTE_ARRAY_TYPE = 24,
WS_DESCRIPTION_TYPE = 25,
WS_STRUCT_TYPE = 26,
WS_CUSTOM_TYPE = 27,
WS_ENDPOINT_ADDRESS_TYPE = 28,
WS_FAULT_TYPE = 29,
WS_VOID_TYPE = 30,
WS_ENUM_TYPE = 31,
WS_DURATION_TYPE = 32,
WS_UNION_TYPE = 33,
WS_ANY_ATTRIBUTES_TYPE = 34
} WS_TYPE;
Constants
WS_BOOL_TYPE Value: 0 Used when serializing a BOOL value. The WS_BOOL_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_INT8_TYPE Value: 1 Used when serializing a signed 8-bit integer (char). The WS_INT8_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_INT16_TYPE Value: 2 Used when serializing a signed 16-bit integer (short). The WS_INT16_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_INT32_TYPE Value: 3 Used when serializing a signed 32-bit integer. The WS_INT32_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_INT64_TYPE Value: 4 Used when serializing a signed 64-bit integer. The WS_INT64_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UINT8_TYPE Value: 5 Used when serializing an unsigned 8-bit integer (BYTE). The WS_UINT8_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UINT16_TYPE Value: 6 Used when serializing an unsigned 16-bit integer. The WS_UINT16_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UINT32_TYPE Value: 7 Used when serializing an unsigned 32-bit integer. The WS_UINT32_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UINT64_TYPE Value: 8 Used when serializing an unsigned 64-bit integer. The WS_UINT64_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_FLOAT_TYPE Value: 9 Used when serializing a float. The WS_FLOAT_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_DOUBLE_TYPE Value: 10 Used when serializing a double. The WS_DOUBLE_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_DECIMAL_TYPE Value: 11 Used when serializing a DECIMAL. The WS_DECIMAL_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_DATETIME_TYPE Value: 12 Used when serializing a WS_DATETIME. The WS_DATETIME_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_TIMESPAN_TYPE Value: 13 Used when serializing a WS_TIMESPAN. The WS_TIMESPAN_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_GUID_TYPE Value: 14 Used when serializing a GUID. The WS_GUID_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UNIQUE_ID_TYPE Value: 15 Used when serializing a WS_UNIQUE_ID. The WS_UNIQUE_ID_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_STRING_TYPE Value: 16 Used when serializing a WS_STRING. The WS_STRING_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented by setting the chars field to NULL and specifying a length of 0. A nil string is distinguished from an empty string based on whether or not the chars field is NULL when the length is zero. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|||||||
WS_WSZ_TYPE Value: 17 Used when serializing a zero-terminated WCHAR*. The WS_WSZ_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. Deserialization will return an error if the wire form of the string contains an embedded zero. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. The default value should point to the address of a WCHAR*, and the size should be sizeof(WCHAR*). |
|||||||
WS_BYTES_TYPE Value: 18 Used when serializing a WS_BYTES. The WS_BYTES_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented by setting the bytes field to NULL and specifying a length of 0. A nil array is distinguished from an empty array based on whether or not the bytes field is NULL when the length is zero. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|||||||
WS_XML_STRING_TYPE Value: 19 Used when serializing a WS_XML_STRING. The WS_XML_STRING_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. Embedded zeros are allowed in the array of utf8 bytes. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented by setting the bytes field to NULL and specifying a length of 0. A nil string is distinguished from an empty string based on whether or not the bytes field is NULL when the length is zero. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|||||||
WS_XML_QNAME_TYPE Value: 20 Used when serializing a WS_XML_QNAME. The WS_XML_QNAME_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER. WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_XML_BUFFER_TYPE Value: 21 Used when serializing an WS_XML_BUFFER*. This type has no associated type description structure. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. This type does not support specifying a WS_DEFAULT_VALUE. The interpretation of the contents of the WS_XML_BUFFER is as follows:
|
|||||||
WS_CHAR_ARRAY_TYPE Value: 22 Used when serializing two fields of a structure as a unit: a WCHAR* field which points to an array of WCHARs, and a ULONG field which contains the number of characters in the array. This type may only be used within a WS_FIELD_DESCRIPTION.
The fields can be anywhere in the contained structure and in any order, since their offsets within the structure are specified separately as part of the WS_FIELD_DESCRIPTION. The offset of the count field is specified in the countOffset field, and the offset of the chars field is specified in the offset field. Embedded zeros are allowed in the array of characters. The WS_CHAR_ARRAY_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type cannot be used with any WS_TYPE_MAPPING values. This type may only be used within a WS_FIELD_DESCRIPTION. This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_NILLABLE_ITEM WS_FIELD_OPTIONAL |
WS_FIELD_NILLABLE_ITEM WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil string is represented by setting the chars field to NULL and specifying a length of 0. A nil string is distinguished from an empty string based on whether or not the chars field is NULL (in both cases the length is zero). This type does not support specifying a WS_DEFAULT_VALUE. |
|||||||
WS_UTF8_ARRAY_TYPE Value: 23 Used when serializing two fields of a structure as a unit: a BYTE* field which points to an array of UTF8 bytes, and a ULONG field which contains the number of bytes in the array. This type may only be used within a WS_FIELD_DESCRIPTION.
The fields can be anywhere in the contained structure and in any order, since their offsets within the structure are specified separately as part of the WS_FIELD_DESCRIPTION. The offset of the count field is specified in the countOffset field, and the offset of the bytes field is specified in the offset field. Embedded zeros are allowed in the array of utf8 bytes. The WS_UTF8_ARRAY_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type cannot be used with any WS_TYPE_MAPPING values. This type may only be used within a WS_FIELD_DESCRIPTION. This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL A nil string is represented by setting the bytes field to NULL and specifying a length of 0. A nil string is distinguished from an empty string based on whether or not the bytes field is NULL (in both cases the length is zero). This type does not support specifying a WS_DEFAULT_VALUE. |
|||||||||||
WS_BYTE_ARRAY_TYPE Value: 24 Used when serializing two fields of a structure as a unit: a BYTE* field which points to an array bytes, and a ULONG field which contains the number of bytes in the array. This type may only be used within a WS_FIELD_DESCRIPTION.
The fields can be anywhere in the contained structure and in any order, since their offsets within the structure are specified separately as part of the WS_FIELD_DESCRIPTION. The offset of the count field is specified in the countOffset field, and the offset of the bytes field is specified in the offset field. The WS_BYTE_ARRAY_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type cannot be used with any WS_TYPE_MAPPING values. This type may only be used within a WS_FIELD_DESCRIPTION. This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_OPTIONAL A nil array is represented by setting the array pointer field to NULL and specifying a length of 0. A nil array is distinguished from an empty array based on whether or not the array pointer field is NULL (in both cases the length is zero). This type does not support specifying a WS_DEFAULT_VALUE. |
|||||||||||
WS_DESCRIPTION_TYPE Value: 25 Used to represent the XML type of the structure being serialized. This can be used to identify sub-types using the xsi:type attribute from XML Schema. The field of the structure must be of type WS_STRUCT_DESCRIPTION*. This type does not have an associated type description. This type cannot be used with any WS_TYPE_MAPPING values. This type may only be used within a WS_FIELD_DESCRIPTION. This type does not support specifying a WS_DEFAULT_VALUE. This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value:
|
||||||||||||
WS_STRUCT_TYPE Value: 26 Used when serializing a user-defined structure. The associated type description points to a WS_STRUCT_DESCRIPTION which provides information about how to serialize the fields of the structure. This type requires a WS_STRUCT_DESCRIPTION type description to be supplied which provides information about how to serialize the type. This type can be used with the following WS_TYPE_MAPPING values, as long as the fields defined by the structure follow the stated restrictions:
This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER WS_FIELD_NILLABLE |
WS_FIELD_POINTER WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. This type does not support specifying a WS_DEFAULT_VALUE. |
WS_CUSTOM_TYPE Value: 27 Used when serializing a custom type. The associated type description points to a WS_CUSTOM_TYPE_DESCRIPTION which provides information about how to serialize the type. This type requires a WS_CUSTOM_TYPE_DESCRIPTION type description to be supplied which provides information about how to serialize the type, including a WS_READ_TYPE_CALLBACK and WS_WRITE_TYPE_CALLBACK which are used to read and write the type. The callbacks are passed the WS_TYPE_MAPPING and make the determination as to whether the mapping is supported. The support for each WS_FIELD_MAPPING value is dependent on the WS_TYPE_MAPPING support determined by the callback. The rules are as follows:
Regardless of what WS_TYPE_MAPPING values are supported, the type can always be used with WS_NO_FIELD_MAPPING. This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|||
WS_ENDPOINT_ADDRESS_TYPE Value: 28 Used when serializing WS_ENDPOINT_ADDRESS . The associated type description points to a WS_ENDPOINT_ADDRESS_DESCRIPTION which provides information about how to serialize the endpoint address. This type requires a WS_ENDPOINT_ADDRESS_DESCRIPTION type description to be supplied which provides information about the serialization format. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER WS_FIELD_NILLABLE |
WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. This type does not support specifying a WS_DEFAULT_VALUE. |
WS_FAULT_TYPE Value: 29 Used when serializing a WS_FAULT. The associated type description points to a WS_FAULT_DESCRIPTION which provides information about how to serialize the fault. This type requires a WS_FAULT_DESCRIPTION type description to be supplied which provides information about the serialization format. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER WS_FIELD_NILLABLE |
WS_FIELD_POINTER WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. This type does not support specifying a WS_DEFAULT_VALUE. |
WS_VOID_TYPE Value: 30 This type is used to specify an arbitrary size field. A WS_VOID_DESCRIPTION can optionally be supplied in order to specify the size of the type. This type cannot be used with any WS_TYPE_MAPPING values. This type can only be used within the WS_FIELD_DESCRIPTION of a WS_STRUCT_DESCRIPTION. This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_POINTER WS_FIELD_POINTER This type can be used with the following WS_FIELD_MAPPING values:
|
|||||||||||
WS_ENUM_TYPE Value: 31 Used when serializing a signed 32-bit integer which corresponds to an enumerated value. This type requires a WS_ENUM_DESCRIPTION type description to be supplied which provides information about the enumeration values and their corresponding serialized form. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_DURATION_TYPE Value: 32 Used when serializing a WS_DURATION. The WS_DURATION_DESCRIPTION type description can optionally be specified for this type in order to constrain the allowed values. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values:
This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: |
WS_FIELD_NILLABLE WS_FIELD_NILLABLE |
WS_FIELD_OPTIONAL | WS_FIELD_POINTER WS_FIELD_POINTER |
WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM WS_FIELD_POINTER |
WS_FIELD_NILLABLE | WS_FIELD_OPTIONAL | WS_FIELD_NILLABLE_ITEM A nil value is represented using a NULL pointer. A WS_DEFAULT_VALUE may be specified for this type. See the documentation for WS_FIELD_MAPPING to see which field mapping values allow a default value to be specified. |
|
WS_UNION_TYPE Value: 33 Used when serializing a set of choices which correspond to a tagged union.
This type requires a WS_UNION_DESCRIPTION type description to be supplied which provides information about the choices and their corresponding serialized form. This type can be used with the following WS_TYPE_MAPPING values: This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value: This type does not support nil values. This type does not support specifying a WS_DEFAULT_VALUE. When used with WS_FIELD_OPTIONAL, the default value in the union is specified using the nonEnumValue of the WS_UNION_DESCRIPTION. |
||||||||||||
WS_ANY_ATTRIBUTES_TYPE Value: 34 Used when serializing a set of attributes that are not mapped to fields using WS_ANY_ATTRIBUTES. This type does not have an associated type description. This type cannot be used with any WS_TYPE_MAPPING values. This type may only be used within a WS_FIELD_DESCRIPTION. This type can be used with the following WS_FIELD_MAPPING values: This type can be used with the following WS_FIELD_OPTIONS values. See the documentation for WS_FIELD_MAPPING for which options are supported for a given field mapping value:
This type does not support nil values. This type does not support specifying a WS_DEFAULT_VALUE. |
Remarks
Many of the WS_TYPEs have a corresponding type description structure which allows for additional information used to serialize or deserialize the type.
For example, the WS_INT32_TYPE has a WS_INT32_DESCRIPTION structure which allows for constraints on the deserialized values. This is an optional type description (if not specified, the full 32-bit integer space is allowed).
Another example is the WS_STRUCT_TYPE, which allows for the specification of a user-defined structure with fields. The fields are described in a WS_STRUCT_DESCRIPTION. This type description is required.
Type description pointers accompany WS_TYPE in the various APIs and structures that are based on serialization. This should be NULL or non-NULL based on whether or not the type description is not defined, optional or required.
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 |