Partager via

WS_FIELD_DESCRIPTION structure (webservices.h)

  • Article

Représente des informations de sérialisation sur un champ au sein d’une structure.

Syntaxe

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;

Membres

mapping

Identifie la façon dont le champ est mappé au code XML. Consultez WS_FIELD_MAPPING pour connaître les façons dont le champ peut être exposé dans le contenu XML.

localName

Nom local XML à utiliser pour le champ.

Ce champ est obligatoire, sauf dans le cas suivant, où il peut être NULL. Si le champ de mappage est WS_REPEATING_ELEMENT_FIELD_MAPPING, cela identifie le nom local de l’élément « wrapper » qui est l’élément parent des éléments de tableau. La définition de ce champ (et du champ ns) sur NULL omet l’élément wrapper. Les champs ns et localName doivent être spécifiés ou null à la fois.

ns

Espace de noms XML à utiliser pour le champ.

Ce champ est obligatoire, sauf dans le cas suivant, où il peut être NULL. Si le champ de mappage est WS_REPEATING_ELEMENT_FIELD_MAPPING, cela identifie l’espace de noms de l’élément « wrapper » qui est l’élément parent des éléments du tableau. La définition de ce champ (et du champ localName) sur NULL omet l’élément wrapper. Les champs ns et localName doivent être spécifiés ou null à la fois.

type

Type du champ. Consultez WS_TYPE pour obtenir la liste des types pris en charge.

typeDescription

Informations supplémentaires sur le type. Chaque type a une structure de description différente. Cela peut être NULL, selon le WS_TYPE.

offset

Décalage du champ dans la structure conteneur.

options

Indicateurs supplémentaires pour le champ. Consultez WS_FIELD_OPTIONS pour obtenir la liste des indicateurs. Si aucun indicateur n’est nécessaire, il peut s’agir de 0.

defaultValue

Pointe vers une valeur par défaut pour le champ. Il est utilisé dans les instances suivantes :

Si defaultValue a la valeur NULL, cela équivaut à avoir une valeur par défaut de tous les zéros.

countOffset

Décalage de structure du champ ULONG qui représente le nombre d’éléments dans le tableau.

Ce champ est utilisé lors de l’utilisation de types WS_REPEATING_ELEMENT_FIELD_MAPPING ou tableaux (WS_CHAR_ARRAY_TYPE, WS_UTF8_ARRAY_TYPE, WS_BYTE_ARRAY_TYPE).
Dans d’autres cas, il n’est pas nécessaire de le spécifier (il peut s’agir de 0).

itemLocalName

Nom local XML à utiliser pour les éléments répétitifs lors de l’utilisation de WS_REPEATING_ELEMENT_FIELD_MAPPING.

Dans d’autres cas, ce champ n’a pas besoin d’être spécifié (il peut être NULL).

itemNs

Espace de noms XML à utiliser pour les éléments répétitifs lors de l’utilisation de WS_REPEATING_ELEMENT_FIELD_MAPPING.

Dans d’autres cas, ce champ n’a pas besoin d’être spécifié (il peut être NULL).

itemRange

Nombre minimal et maximal d’éléments répétitifs pouvant apparaître lors de l’utilisation de WS_REPEATING_ELEMENT_FIELD_MAPPING, de WS_REPEATING_ELEMENT_CHOICE_FIELD_MAPPING ou de WS_REPEATING_ANY_ELEMENT_FIELD_MAPPING. S’il n’est pas spécifié (NULL), la valeur minimale est 0 et la valeur maximale est MAX ULONG.

Dans d’autres cas, ce champ n’a pas besoin d’être spécifié (il peut être NULL).

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
En-tête webservices.h