WsSendMessage, fonction (webservices.h)

Article
08/27/2023

Envoyez un message sur un canal à l’aide de la sérialisation pour écrire l’élément body.

Syntaxe

HRESULT WsSendMessage(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_MESSAGE_DESCRIPTION *messageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *bodyValue,
  [in]           ULONG                        bodyValueSize,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

Paramètres

[in] channel

Canal sur lequel envoyer le message.

[in] message

Objet de message à utiliser pour l’envoi.

L’objet message doit être en WS_MESSAGE_STATE_EMPTY ou WS_MESSAGE_STATE_INITIALIZED.

[in] messageDescription

Le champ d’action du WS_MESSAGE_DESCRIPTION est utilisé comme en-tête d’action pour le message. Ce champ peut être NULL si aucune action n’est requise.

Le champ bodyElementDescription du WS_MESSAGE_DESCRIPTION est utilisé pour sérialiser le corps du message. Ce champ peut être NULL si aucun élément body n’est souhaité. Pour plus d’informations sur la façon dont bodyElementDescription est utilisé pour sérialiser la valeur, consultez WsWriteBody .

[in] writeOption

Indique si l’élément body est requis et comment la valeur est allouée. Ceci est utilisé uniquement lorsqu’un élément body est souhaité. Pour plus d’informations, consultez WS_WRITE_OPTION et WsWriteBody.

bodyValue

Valeur à sérialiser dans le corps du message.

[in] bodyValueSize

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

[in, optional] asyncContext

Informations sur la façon d’appeler la fonction de manière asynchrone, ou NULL en cas d’appel synchrone.

[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_S_ASYNC	L’opération asynchrone est toujours en attente.
WS_E_OPERATION_ABORTED	L'opération a été abandonnée.
WS_E_INVALID_OPERATION	L’opération n’est pas autorisée en raison de l’état actuel de l’objet.
WS_E_ENDPOINT_NOT_FOUND	Le point de terminaison distant n’existe pas ou n’a pas pu être localisé.
WS_E_ENDPOINT_ACCESS_DENIED	L’accès a été refusé par le point de terminaison distant.
WS_E_ENDPOINT_DISCONNECTED	La connexion avec le point de terminaison distant a été interrompue.
WS_E_ENDPOINT_FAILURE	Le point de terminaison distant n’a pas pu traiter la demande.
WS_E_ENDPOINT_NOT_AVAILABLE	Le point de terminaison distant n’est actuellement pas en service à cet emplacement.
WS_E_ENDPOINT_TOO_BUSY	Le point de terminaison distant ne peut pas traiter la demande en raison d’une surcharge.
WS_E_ENDPOINT_UNREACHABLE	Le point de terminaison distant n’était pas accessible.
WS_E_INVALID_ENDPOINT_URL	L’URL de l’adresse du point de terminaison n’est pas valide.
WS_E_INVALID_FORMAT	Les données d’entrée n’étaient pas au format attendu ou n’avaient pas la valeur attendue.
WS_E_OPERATION_TIMED_OUT	L’opération ne s’est pas terminée dans le délai imparti.
WS_E_PROXY_ACCESS_DENIED	L’accès a été refusé par le serveur proxy HTTP.
WS_E_PROXY_FAILURE	Le serveur proxy HTTP n’a pas pu traiter la requête.
WS_E_QUOTA_EXCEEDED	Un quota a été dépassé.
WS_E_SECURITY_VERIFICATION_FAILURE	La vérification de sécurité n’a pas réussi pour les données reçues.
WS_E_SECURITY_SYSTEM_FAILURE	Une opération de sécurité a échoué dans l’infrastructure des services Web Windows.
WS_E_SECURITY_TOKEN_EXPIRED	Un jeton de sécurité a été rejeté par le serveur, car il a expiré.
WS_E_PROXY_REQUIRES_BASIC_AUTH	Le serveur proxy HTTP nécessite le schéma d’authentification HTTP « de base ».
WS_E_PROXY_REQUIRES_DIGEST_AUTH	Le serveur proxy HTTP nécessite le schéma d’authentification HTTP « digest ».
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH	Le serveur proxy HTTP nécessite le schéma d’authentification HTTP « negotiate ».
WS_E_PROXY_REQUIRES_NTLM_AUTH	Le serveur proxy HTTP nécessite le schéma d’authentification HTTP « NTLM ».
WS_E_SERVER_REQUIRES_BASIC_AUTH	Le point de terminaison distant nécessite le schéma d’authentification HTTP « de base ».
WS_E_SERVER_REQUIRES_DIGEST_AUTH	Le point de terminaison distant nécessite le schéma d’authentification HTTP « digest ».
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH	Le point de terminaison distant nécessite le schéma d’authentification HTTP « negotiate ».
WS_E_SERVER_REQUIRES_NTLM_AUTH	Le point de terminaison distant nécessite le schéma d’authentification HTTP « NTLM ».
CERT_E_EXPIRED	Un certificat requis n’est pas dans sa période de validité lors de la vérification par rapport à l’horloge système actuelle ou à l’horodatage dans le fichier signé.
CERT_E_CN_NO_MATCH	Le nom CN des certificats ne correspond pas à la valeur passée.
CERT_E_UNTRUSTEDROOT	Chaîne de certificats traitée, mais terminée dans un certificat racine qui n’est pas approuvé par le fournisseur d’approbation.
CERT_E_WRONG_USAGE	Le certificat n'est pas valide pour l'utilisation demandée.
CRYPT_E_REVOCATION_OFFLINE	La fonction de révocation n’a pas pu vérifier la révocation car le serveur de révocation était déconnecté.
E_OUTOFMEMORY	Mémoire insuffisante.
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

Pour inclure des en-têtes personnalisés avec le message, initialisez le message WsInitializeMessage avec WS_BLANK_MESSAGE , puis ajoutez les en-têtes à l’aide de WsAddCustomHeader avant d’appeler cette fonction.

Configuration requise


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