estructura WS_FIELD_DESCRIPTION (webservices.h)

Representa información de serialización sobre un campo dentro de una estructura.

Sintaxis

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;

Miembros

mapping

Identifica cómo se asigna el campo al XML. Vea WS_FIELD_MAPPING para conocer las formas en que el campo se puede exponer en el contenido XML.

localName

Nombre local XML que se va a usar para el campo.

Este campo es obligatorio, excepto en el caso siguiente, donde puede ser NULL. Si el campo de asignación es WS_REPEATING_ELEMENT_FIELD_MAPPING, esto identifica el nombre local del elemento "contenedor" que es el elemento primario de los elementos del elemento de matriz. Si se establece este campo (y el campo ns) en NULL se omitirá el elemento contenedor. Los campos ns y localName deben especificarse o ambos valores NULL.

ns

Espacio de nombres XML que se va a usar para el campo.

Este campo es obligatorio, excepto en el caso siguiente, donde puede ser NULL. Si el campo de asignación es WS_REPEATING_ELEMENT_FIELD_MAPPING, esto identifica el espacio de nombres del elemento "contenedor" que es el elemento primario de los elementos del elemento de matriz. Si se establece este campo (y el campo localName) en NULL se omitirá el elemento contenedor. Los campos ns y localName deben especificarse o ambos valores NULL.

type

Tipo del campo. Consulte WS_TYPE para obtener una lista de los tipos admitidos.

typeDescription

Información adicional sobre el tipo. Cada tipo tiene una estructura de descripción diferente. Puede ser NULL, dependiendo del WS_TYPE.

offset

Desplazamiento del campo dentro de la estructura contenedora.

options

Marcas adicionales para el campo. Consulte WS_FIELD_OPTIONS para obtener una lista de marcas. Si no se necesitan marcas, puede ser 0.

defaultValue

Apunta a un valor predeterminado para el campo. Esto se usa en las siguientes instancias:

• WS_FIELD_OPTIONAL se especificó y el XML no contenía el valor .
• WS_NO_FIELD_MAPPING se especificó.

Si defaultValue es NULL, es lo mismo que tener un valor predeterminado de todos los ceros.

countOffset

Desplazamiento de estructura del campo ULONG que representa el número de elementos de la matriz.

Este campo se usa al usar WS_REPEATING_ELEMENT_FIELD_MAPPING o tipos de matriz (WS_CHAR_ARRAY_TYPE, WS_UTF8_ARRAY_TYPE, WS_BYTE_ARRAY_TYPE).
En otros casos, no es necesario especificarlo (puede ser 0).

itemLocalName

Nombre local XML que se va a usar para los elementos repetidos al usar WS_REPEATING_ELEMENT_FIELD_MAPPING.

En otros casos, no es necesario especificar este campo (puede ser NULL).

itemNs

Espacio de nombres XML que se va a usar para los elementos repetidos al usar WS_REPEATING_ELEMENT_FIELD_MAPPING.

En otros casos, no es necesario especificar este campo (puede ser NULL).

itemRange

Número mínimo y máximo de elementos repetidos que pueden aparecer al usar WS_REPEATING_ELEMENT_FIELD_MAPPING, WS_REPEATING_ELEMENT_CHOICE_FIELD_MAPPING o WS_REPEATING_ANY_ELEMENT_FIELD_MAPPING. Si no se especifica (NULL), el mínimo es 0 y el máximo es MAX ULONG.

En otros casos, no es necesario especificar este campo (puede ser NULL).

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 R2 [solo aplicaciones de escritorio]
Encabezado	webservices.h