WsMarkHeaderAsUnderstood, fonction (webservices.h)

Article
03/03/2024

Cette fonction marque un en-tête comme « compris » par l’application.

L’ensemble d’en-têtes est extensible et l’assimilation des messages par le destinataire n’est pas accessible par l’expéditeur. Cette fonction est la méthode d’applications de réception permettant de faire savoir à l’expéditeur que l’en-tête reçu a été lu et compris.

Note Cette fonction ne doit être utilisée que si l’application reçoit un message indiquant que l’en-tête doit être compris et qu’elle n’a pas acquis l’en-tête à l’aide de WsGetHeader ou WsGetCustomHeader.

Le WS_MESSAGE_STATE doit être défini sur WS_MESSAGE_STATE_READING. Voir. WsCheckMustUnderstandHeaders pour plus d’informations.

Syntaxe

HRESULT WsMarkHeaderAsUnderstood(
  [in]           WS_MESSAGE                 *message,
  [in]           const WS_XML_NODE_POSITION *headerPosition,
  [in, optional] WS_ERROR                   *error
);

Paramètres

[in] message

Pointeur vers l’objet Message avec l’en-tête à marquer.

[in] headerPosition

Pointeur vers la position de l’élément header dans le segment d’en-tête XML.

[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
WS_E_INVALID_OPERATION	Le message n’est pas dans l’état correct.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
E_OUTOFMEMORY	Nous avons manqué de mémoire.
Autres erreurs	Cette fonction peut renvoyer d’autres erreurs non répertoriées ci-dessus.

Remarques

Lorsque l’application lit l’en-tête à l’aide d’un lecteur XML, elle doit obtenir une WS_XML_NODE_POSITION de l’élément header et la passer à cette fonction. Pour savoir comment obtenir un WS_XML_NODE_POSITION, consultez WsGetReaderPosition.

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