WsCreateMessage, fonction (webservices.h)

Article
03/06/2024

Crée un objet message avec les propriétés spécifiées.

Syntaxe

HRESULT WsCreateMessage(
  [in]           WS_ENVELOPE_VERSION       envelopeVersion,
  [in]           WS_ADDRESSING_VERSION     addressingVersion,
                 const WS_MESSAGE_PROPERTY *properties,
  [in]           ULONG                     propertyCount,
                 WS_MESSAGE                **message,
  [in, optional] WS_ERROR                  *error
);

Paramètres

[in] envelopeVersion

Valeur d’énumération WS_ENVELOPE_VERSION qui spécifie la version de l’enveloppe du message.

[in] addressingVersion

WS_ADDRESSING_VERSION qui spécifie la version de l’adressage du message.

properties

Tableau de propriétés facultatives pour le message. Voir WS_MESSAGE_PROPERTY.

La valeur de ce paramètre peut être NULL, auquel cas le paramètre propertyCount doit être égal à 0 (zéro).

[in] propertyCount

Nombre de propriétés dans le tableau de propriétés .

message

En cas de réussite, un pointeur qui reçoit l’adresse d’une structure de WS_MESSAGE représentant le nouveau message.

Lorsque vous n’avez plus besoin de cette structure, vous devez la libérer en appelant WsFreeMessage.

[in, optional] error

Pointeur vers une structure de WS_ERROR qui reçoit des informations d’erreur supplémentaires en cas d’échec de la fonction.

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR ; sinon, elle retourne un code d’erreur HRESULT.

Code de retour	Description
E_OUTOFMEMORY	Mémoire insuffisante pour terminer l’opération.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
Autres erreurs	Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

Remarques

Un objet message est le véhicule de livraison pour les services Web Windows. Un seul objet de message peut être utilisé pour envoyer ou recevoir des messages séquentiels. La réutilisation d’un objet message de cette façon peut réduire les allocations de mémoire. Lorsque vous n’avez plus besoin du message, vous devez libérer de la mémoire en appelant WsFreeMessage. (Pour plus d’informations sur la réutilisation d’objets message, consultez WsResetMessage .)

Si vous créez un message à utiliser avec un canal particulier, utilisez la fonction WsCreateMessageForChannel , qui garantit la bonne version du message pour le canal.

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