estrutura WS_FIELD_DESCRIPTION (webservices.h)

Representa informações de serialização sobre um campo dentro de uma estrutura.

Sintaxe

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;

Membros

mapping

Identifica como o campo é mapeado para o XML. Confira WS_FIELD_MAPPING para saber como o campo pode ser exposto no conteúdo XML.

localName

O nome local XML a ser usado para o campo.

Esse campo é necessário, exceto no caso a seguir, em que pode ser NULL. Se o campo de mapeamento for WS_REPEATING_ELEMENT_FIELD_MAPPING, isso identificará o nome local do elemento "wrapper" que é o elemento pai dos elementos do item de matriz. Definir esse campo (e o campo ns) como NULL omitirá o elemento wrapper. Os campos ns e localName devem ser especificados ou NULL.

ns

O namespace XML a ser usado para o campo.

Esse campo é necessário, exceto no caso a seguir, em que pode ser NULL. Se o campo de mapeamento for WS_REPEATING_ELEMENT_FIELD_MAPPING, isso identificará o namespace do elemento "wrapper" que é o elemento pai dos elementos do item de matriz. Definir esse campo (e o campo localName) como NULL omitirá o elemento wrapper. Os campos ns e localName devem ser especificados ou NULL.

type

O tipo do campo. Consulte WS_TYPE para obter uma lista de tipos com suporte.

typeDescription

Informações adicionais sobre o tipo. Cada tipo tem uma estrutura de descrição diferente. Isso pode ser NULL, dependendo do WS_TYPE.

offset

O deslocamento do campo dentro da estrutura que contém.

options

Sinalizadores adicionais para o campo. Consulte WS_FIELD_OPTIONS para obter uma lista de sinalizadores. Se nenhum sinalizador for necessário, isso poderá ser 0.

defaultValue

Aponta para um valor padrão para o campo. Isso é usado nas seguintes instâncias:

• WS_FIELD_OPTIONAL foi especificado e o XML não continha o valor.
• WS_NO_FIELD_MAPPING foi especificado.

countOffset

O deslocamento de estrutura do campo ULONG que representa o número de itens na matriz.

Esse campo é usado ao usar WS_REPEATING_ELEMENT_FIELD_MAPPING ou tipos de matriz (WS_CHAR_ARRAY_TYPE, WS_UTF8_ARRAY_TYPEWS_BYTE_ARRAY_TYPE).
Em outros casos, ele não precisa ser especificado (pode ser 0).

itemLocalName

O nome local XML a ser usado para os elementos repetidos ao usar WS_REPEATING_ELEMENT_FIELD_MAPPING.

Em outros casos, esse campo não precisa ser especificado (pode ser NULL).

itemNs

O namespace XML a ser usado para os elementos repetidos ao usar WS_REPEATING_ELEMENT_FIELD_MAPPING.

Em outros casos, esse campo não precisa ser especificado (pode ser NULL).

itemRange

O número mínimo e máximo de elementos repetidos que podem aparecer ao usar WS_REPEATING_ELEMENT_FIELD_MAPPING, WS_REPEATING_ELEMENT_CHOICE_FIELD_MAPPING ou WS_REPEATING_ANY_ELEMENT_FIELD_MAPPING. Se não for especificado (NULL), o mínimo será 0 e o máximo será MAX ULONG.

Em outros casos, esse campo não precisa ser especificado (pode ser NULL).

Requisitos