Función WsInitializeMessage (webservices.h)

Esta función inicializa los encabezados del mensaje como preparación para su procesamiento. Después de inicializar un mensaje, una aplicación puede agregar encabezados adicionales. Si se ejecuta correctamente, el mensaje está en estado WS_MESSAGE_STATE_INITIALIZED . Si se produce un error en la función, no se produce ninguna transición de estado.

Sintaxis

HRESULT WsInitializeMessage(
  [in]           WS_MESSAGE                *message,
  [in]           WS_MESSAGE_INITIALIZATION initialization,
  [in, optional] WS_MESSAGE                *sourceMessage,
  [in, optional] WS_ERROR                  *error
);

Parámetros

[in] message

Puntero al objeto Message que se va a inicializar. El mensaje debe ser una instancia de objeto WS_MESSAGE válida devuelta por WsCreateMessage o WsCreateMessageForChannel y no puede ser NULL.

[in] initialization

Define la inicialización del mensaje.

Nota Si el valor de inicialización se establece en WS_REPLY_MESSAGE o WS_FAULT_MESSAGE el mensaje se dirige automáticamente.

 

[in, optional] sourceMessage

Puntero a un objeto de mensaje que se usa para inicializar el parámetro message . Este valor debe ser NULL a menos que el parámetro de inicialización tenga el valor de WS_DUPLICATE_MESSAGE, WS_REPLY_MESSAGE o WS_FAULT_MESSAGE.

[in, optional] error

Puntero a un objeto WS_ERROR donde se debe almacenar información adicional sobre el error si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
E_OUTOFMEMORY	Se quedó sin memoria.
E_INVALIDARG	Uno o más argumentos no son válidos.
Otros errores	Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

El remitente inicial de un mensaje debe agregar un encabezado de acción al mensaje mediante WsSetHeader.

Se debe llamar a esta API antes de llamar a WsWriteEnvelopeStart o WsWriteMessageStart para el mensaje.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	webservices.h
Library	WebServices.lib
Archivo DLL	WebServices.dll