Fonction WsAddMappedHeader (webservices.h)

Ajoute un en-tête mappé spécifié au message.

Syntaxe

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Paramètres

[in] message

Pointeur vers une structure WS_MESSAGE représentant le message auquel ajouter l’en-tête mappé.

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

[in] headerName

Pointeur vers un WS_XML_STRING contenant le nom de l’en-tête.

[in] valueType

Type de valeur d’en-tête à désérialiser. Pour connaître les types possibles et les en-têtes correspondants, consultez les WS_HEADER_TYPE

[in] writeOption

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

[in] 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, 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.

Remarques

Un message peut contenir des informations supplémentaires spécifiques au transport qui ne font pas partie de l’enveloppe du message. Ces informations spécifiques au transport peuvent être exposées par programmation sous forme d’en-têtes du message. La fonction WsAddMappedHeader est utilisée pour ajouter un tel en-tête qui sera mappé à un emplacement spécifique au transport.

Lorsque vous utilisez le canal HTTP, vous devez spécifier les mappages requis avant d’appeler cette fonction pour ajouter les en-têtes. Pour plus d’informations, consultez WS_HTTP_MESSAGE_MAPPING.

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

Configuration requise