WS_FIELD_DESCRIPTION 结构 (webservices.h)
表示有关结构中字段的序列化信息。
语法
typedef struct _WS_FIELD_DESCRIPTION {
WS_FIELD_MAPPING mapping;
WS_XML_STRING *localName;
WS_XML_STRING *ns;
WS_TYPE type;
void *typeDescription;
ULONG offset;
ULONG options;
WS_DEFAULT_VALUE *defaultValue;
ULONG countOffset;
WS_XML_STRING *itemLocalName;
WS_XML_STRING *itemNs;
WS_ITEM_RANGE *itemRange;
} WS_FIELD_DESCRIPTION;
成员
mapping
标识字段如何映射到 XML。 有关字段在 XML 内容中公开的方式,请参阅 WS_FIELD_MAPPING 。
localName
要用于字段的 XML 本地名称。
此字段是必需的,但以下情况除外,其中它可能为 NULL。 如果映射字段 WS_REPEATING_ELEMENT_FIELD_MAPPING,则标识“包装器”元素的本地名称,该元素是数组项元素的父元素。 将此字段 (且 ns 字段) 设置为 NULL 将省略包装元素。 ns 和 localName 字段必须同时指定或同时为 NULL。
ns
要用于字段的 XML 命名空间。
此字段是必需的,但以下情况除外,其中它可能为 NULL。 如果映射字段 WS_REPEATING_ELEMENT_FIELD_MAPPING,则标识“包装器”元素的命名空间,即数组项元素的父元素。 将此字段 (,将 localName 字段) 设置为 NULL 将省略包装元素。 ns 和 localName 字段必须同时指定或同时为 NULL。
type
字段的类型。 有关支持类型的列表 ,请参阅WS_TYPE 。
typeDescription
有关类型的其他信息。 每种类型都有不同的说明结构。 这可能为 NULL,具体取决于 WS_TYPE。
offset
包含结构中字段的偏移量。
options
字段的其他标志。 有关标志列表 ,请参阅WS_FIELD_OPTIONS 。 如果不需要标志,则可能为 0。
defaultValue
指向字段的默认值。 这在以下实例中使用:
- 指定了WS_FIELD_OPTIONAL ,并且 XML 不包含 值。
- 已指定WS_NO_FIELD_MAPPING 。
countOffset
表示数组中项数的 ULONG 字段的结构偏移量。
在 (WS_CHAR_ARRAY_TYPE、WS_UTF8_ARRAY_TYPE WS_BYTE_ARRAY_TYPE) 使用WS_REPEATING_ELEMENT_FIELD_MAPPING或数组类型时使用此字段。
在其他情况下,无需指定它, (它可以是 0) 。
itemLocalName
使用 WS_REPEATING_ELEMENT_FIELD_MAPPING 时要用于重复元素的 XML 本地名称。
在其他情况下,无需指定此字段, (可以为 NULL) 。
itemNs
使用 WS_REPEATING_ELEMENT_FIELD_MAPPING 时要用于重复元素的 XML 命名空间。
在其他情况下,无需指定此字段, (可以为 NULL) 。
itemRange
使用WS_REPEATING_ELEMENT_FIELD_MAPPING、WS_REPEATING_ELEMENT_CHOICE_FIELD_MAPPING或WS_REPEATING_ANY_ELEMENT_FIELD_MAPPING时可能出现的重复元素的最小和最大数目。 如果未 (NULL) 指定,则最小值为 0,最大值为 MAX ULONG。
在其他情况下,无需指定此字段, (可以为 NULL) 。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 7 [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 R2 [仅限桌面应用] |
标头 | webservices.h |