Función WsAddCustomHeader (webservices.h)

Agrega el encabezado definido por la aplicación especificado al mensaje.

Sintaxis

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
);

Parámetros

[in] message

Mensaje al que se va a agregar el encabezado.

El mensaje puede estar en cualquier estado excepto WS_MESSAGE_STATE_EMPTY (vea la enumeración WS_MESSAGE_STATE .

[in] headerDescription

Estructura WS_ELEMENT_DESCRIPTION que describe el encabezado.

[in] writeOption

Indica si se requiere el elemento de encabezado y cómo se asigna el valor. Para obtener más información, vea la enumeración WS_WRITE_OPTION .

[in, ref] value

Valor de encabezado que se va a serializar. Para obtener más información, vea la enumeración WS_WRITE_OPTION .

[in] valueSize

Tamaño del valor que se va a serializar, en bytes.

[in] headerAttributes

Los valores de los atributos SOAP para el encabezado.

[in, optional] error

Puntero a una estructura de WS_ERROR que recibe información de error adicional si se produce un error en la función.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR; de lo contrario, devuelve un código de error HRESULT.

Comentarios

La función WsAddCustomHeader está diseñada para controlar tipos de encabezados destinados al receptor final. Los encabezados dirigidos a otro receptor se omiten.

Si va a reemplazar un encabezado, llame a la función WsRemoveCustomHeader para quitar las instancias existentes del encabezado antes de llamar a WsAddCustomHeader.

Requisitos