Fonction WsInitializeMessage (webservices.h)

  • Article

Cette fonction initialise les en-têtes du message en vue du traitement. Une fois qu’un message a été initialisé, une application peut ajouter des en-têtes supplémentaires. En cas de réussite, le message est à l’état WS_MESSAGE_STATE_INITIALIZED . Si la fonction échoue, aucune transition d’état ne se produit.

Syntaxe

HRESULT WsInitializeMessage(
  [in]           WS_MESSAGE                *message,
  [in]           WS_MESSAGE_INITIALIZATION initialization,
  [in, optional] WS_MESSAGE                *sourceMessage,
  [in, optional] WS_ERROR                  *error
);

Paramètres

[in] message

Pointeur vers l’objet Message à initialiser. Le message doit être un objet WS_MESSAGE valide instance retourné par WsCreateMessage ou WsCreateMessageForChannel et peut ne pas avoir la valeur NULL.

[in] initialization

Définit l’initialisation du message.

Note Si la valeur d’initialisation est définie sur WS_REPLY_MESSAGE ou WS_FAULT_MESSAGE le message est automatiquement adressé.
 

[in, optional] sourceMessage

Pointeur vers un objet de message utilisé pour initialiser le paramètre de message . Cette valeur doit être NULL, sauf si le paramètre d’initialisation a la valeur WS_DUPLICATE_MESSAGE, WS_REPLY_MESSAGE ou WS_FAULT_MESSAGE.

[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_OUTOFMEMORY
 Nous avons manqué de mémoire.
E_INVALIDARG
 Un ou plusieurs arguments ne sont pas valides.
Autres erreurs
Cette fonction peut renvoyer d’autres erreurs non répertoriées ci-dessus.

Remarques

L’expéditeur initial d’un message doit ajouter un en-tête d’action au message à l’aide de WsSetHeader.

Cette API doit être appelée avant que WsWriteEnvelopeStart ou WsWriteMessageStart soit appelé pour le message.

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