WsSetHeader, fonction (webservices.h)

  • Article

Ajoute ou remplace l’en-tête standard spécifié dans le message.

Syntaxe

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

Paramètres

[in] message

Message dans lequel définir l’en-tête.

Le message peut être dans n’importe quel état , mais WS_MESSAGE_STATE_EMPTY.

[in] headerType

Type d’en-tête à sérialiser.

[in] valueType

Type de la valeur à sérialiser. Consultez WS_HEADER_TYPE pour connaître l’ensemble des types pris en charge pour chaque type d’en-tête.

[in] writeOption

Indique si l’élément d’en-tête est requis et comment la valeur est allouée. WS_WRITE_NILLABLE_VALUE et WS_WRITE_NILLABLE_POINTER options d’écriture ne peuvent pas être spécifiés, car les types d’en-tête dans WS_HEADER_TYPE ne sont pas autorisés à être nillables dans les spécifications de normes respectives. Pour plus d’informations, consultez WS_WRITE_OPTION .

value

Valeur d’en-tête à sérialiser. Pour plus d’informations, consultez WS_WRITE_OPTION .

[in] valueSize

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

[in, optional] error

Spécifie l’emplacement où les 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_E_INVALID_FORMAT
 Plusieurs instances du type d’en-tête sont présentes dans le message.
E_OUTOFMEMORY
 La mémoire disponible n’était pas suffisante pour sérialiser l’en-tête.
E_INVALIDARG
 Un ou plusieurs des paramètres sont incorrects.
Autres erreurs
Cette fonction peut renvoyer d’autres erreurs non répertoriées ci-dessus.

Remarques

Cette API permet de définir des types d’en-tête standard (voir WS_HEADER_TYPE). Pour les types d’en-tête définis par l’application, utilisez WsAddCustomHeader.

Cette API est conçue pour gérer les types d’en-têtes qui s’affichent une fois dans le message et qui sont ciblés sur le récepteur final. Les en-têtes ciblés avec un rôle/acteur autre que le récepteur final sont ignorés par cette API.

Si un en-tête du type donné (ciblant le destinataire final) existe déjà dans le message, il est remplacé.

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