WsWriteElement, fonction (webservices.h)

Article
03/03/2024

Écrivez une valeur typée en tant qu’élément XML.

Syntaxe

HRESULT WsWriteElement(
  [in]           WS_XML_WRITER                *writer,
  [in]           const WS_ELEMENT_DESCRIPTION *elementDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *value,
  [in]           ULONG                        valueSize,
  [in, optional] WS_ERROR                     *error
);

Paramètres

[in] writer

Writer dans lequel écrire l’élément.

[in] elementDescription

Pointeur vers une description de la sérialisation de l’élément.

[in] writeOption

Informations sur la façon dont la valeur est allouée. Pour plus d’informations, consultez WS_WRITE_OPTION .

value

Pointeur vers la valeur à sérialiser.

[in] valueSize

Taille de la valeur sérialisée, en octets.

Si la valeur est NULL, la taille doit être 0.

[in, optional] error

Spécifie l’emplacement où des informations d’erreur supplémentaires 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
WS_E_INVALID_FORMAT	Les données d’entrée n’étaient pas au format attendu ou n’avaient pas la valeur attendue.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
E_OUTOFMEMORY	Mémoire insuffisante.

Remarques

Cette API écrit l’élément de début, les attributs, les éléments enfants/texte et l’élément de fin qui correspond à la valeur spécifiée.

Si l’API échoue, l’état de l’enregistreur d’entrée devient indéfini. Les seules API qui peuvent être utilisées sur l’enregistreur si cela se produit sont WsSetOutput et WsSetOutputToBuffer pour renvoyer l’enregistreur à un état utilisable, ou WsFreeWriter pour libérer l’enregistreur.

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

Partager via