Fonction WsAddCustomHeader (webservices.h)

Ajoute l’en-tête défini par l’application spécifié au message.

Syntaxe

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Paramètres

[in] message

Message auquel ajouter l’en-tête.

Le message peut être dans n’importe quel état, sauf WS_MESSAGE_STATE_EMPTY (voir l’énumération WS_MESSAGE_STATE ..

[in] headerDescription

Structure WS_ELEMENT_DESCRIPTION qui décrit l’en-tête.

[in] writeOption

Indique si l’élément d’en-tête est requis et la façon dont la valeur est allouée. Pour plus d’informations, consultez l’énumération WS_WRITE_OPTION .

[in, ref] value

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

[in] valueSize

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

[in] headerAttributes

Valeurs des attributs SOAP pour l’en-tête.

[in, optional] error

Pointeur vers une structure WS_ERROR qui reçoit des informations d’erreur supplémentaires si la fonction échoue.

Valeur retournée

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

Code de retour Description
WS_E_INVALID_FORMAT
Il existe plusieurs instances du même type d’en-tête présent dans le message.
E_OUTOFMEMORY
Mémoire insuffisante pour terminer l’opération.
E_INVALIDARG
Un ou plusieurs des paramètres sont incorrects.
Autres erreurs
Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

Remarques

La fonction WsAddCustomHeader est conçue pour gérer les types d’en-têtes ciblés au récepteur final. Les en-têtes ciblés sur un autre récepteur sont ignorés.

Si vous remplacez un en-tête, appelez la fonction WsRemoveCustomHeader pour supprimer les instances existantes de l’en-tête avant d’appeler WsAddCustomHeader.

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