WsCreateMessageForChannel, fonction (webservices.h)

  • Article

Crée un message à utiliser avec un canal spécifié.

Syntaxe

HRESULT WsCreateMessageForChannel(
  [in]           WS_CHANNEL                *channel,
                 const WS_MESSAGE_PROPERTY *properties,
  [in]           ULONG                     propertyCount,
                 WS_MESSAGE                **message,
  [in, optional] WS_ERROR                  *error
);

Paramètres

[in] channel

Pointeur vers une structure WS_CHANNEL représentant le canal 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 du WS_MESSAGE structure 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, il 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 renvoyer d’autres erreurs non répertoriées ci-dessus.

Remarques

Contrairement à la fonction WsCreateMessage plus générale, WsCreateMessageForChannel garantit que la version de message utilisée est appropriée 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