WsWriteStartElement, fonction (webservices.h)

  • Article

Écrit un élément de démarrage dans l’enregistreur.

Après l’appel de cette fonction , WsWriteStartAttribute ou WsWriteXmlnsAttribute peut être appelé pour écrire des attributs supplémentaires dans l’élément. L’élément n’est pas engagé sur l’enregistreur tant que WsWriteEndElement ou une autre fonction qui écrit du contenu n’est pas appelée.

Syntaxe

HRESULT WsWriteStartElement(
  [in]           WS_XML_WRITER       *writer,
  [in, optional] const WS_XML_STRING *prefix,
  [in]           const WS_XML_STRING *localName,
  [in]           const WS_XML_STRING *ns,
  [in, optional] WS_ERROR            *error
);

Paramètres

[in] writer

Pointeur vers l’objet WS_XML_WRITER dans lequel l’élément start est écrit. Le pointeur doit référencer un objet Writer XML valide.

[in, optional] prefix

Un pointeur WS_XML_STRING vers le préfixe à utiliser pour l’élément start. Si la valeur référencée par ce paramètre est NULL , l’enregistreur choisit un attribut.

[in] localName

Un pointeur WS_XML_STRING vers le nom local utilisé par l’élément start. Il doit comporter au moins un caractère.

[in] ns

Un pointeur WS_XML_STRING vers l’espace de noms à utiliser pour l’élément start.

Si aucun préfixe n’est spécifié, l’enregistreur peut utiliser un préfixe dans l’étendue lié à l’espace de noms spécifié ou générer un préfixe et inclure un attribut XMLNS. Si un préfixe est spécifié, l’enregistreur utilise ce préfixe et peut inclure un attribut XMLNS si nécessaire pour remplacer un préfixe existant dans l’étendue.

[in, optional] error

Pointeur vers un objet WS_ERROR où des informations supplémentaires sur l’erreur doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour Description
E_INVALIDARG
 Un ou plusieurs arguments ne sont pas valides.
WS_E_INVALID_OPERATION
 L’opération n’est pas autorisée en raison de l’état actuel de l’objet.
WS_E_INVALID_FORMAT
 Les données d’entrée n’étaient pas au format attendu ou n’avaient pas la valeur attendue.
WS_E_QUOTA_EXCEEDED
 Un quota a été dépassé.

Remarques

Si l’encodage sous-jacent prend en charge des éléments vides et que l’élément n’a pas de contenu, un élément vide est écrit.

Si un préfixe non vide est spécifié avec un espace de noms vide WS_E_INVALID_FORMAT est retourné.

Si l’écriture de l’élément start entraîne le dépassement de WS_XML_WRITER_PROPERTY_MAX_DEPTHWS_E_QUOTA_EXCEEDED est retourné. (Voir Valeurs de retour des services web Windows.)

Lors de l’utilisation de WS_XML_WRITER_MTOM_ENCODING il s’agit d’une erreur de tentative d’écriture d’un élément avec le nom localName « Include » à partir de l’espace de noms »http://www.w3.org/2004/08/xop/include" ;.

WsWriteStartAttribute peut également être utilisé pour ajouter un attribut à un élément lorsque l’enregistreur est positionné sur un élément à l’aide de WsMoveWriter ou WsSetWriterPosition.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête webservices.h
Bibliothèque WebServices.lib
DLL WebServices.dll