Función WsFlushBody (webservices.h)

  • Artículo

Vacía todos los datos acumulados del cuerpo del mensaje que se han escrito.

Cuando el mensaje usa WsWriteBody o XML Writer, los datos se acumulan en un búfer. WsFlushBody realiza posteriormente la E/S real.

WsFlushBody se usa normalmente cuando la E/S del canal se establece en WS_STREAMED_OUTPUT_TRANSFER_MODE, o cuando se usa un objeto de escritura XML establecido para usar WS_XML_WRITER_STREAM_OUTPUT.

Sintaxis

HRESULT WsFlushBody(
  [in]           WS_MESSAGE             *message,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parámetros

[in] message

Puntero a la estructura WS_MESSAGE que contiene los datos acumulados del cuerpo del mensaje.

[in] minSize

Especifica el número mínimo de bytes que deben estar presentes en el mensaje para que la función realice el vaciado de datos.

Nota Si el mensaje contiene menos de minSize WSFlushBody finaliza sin hacer el vaciado de E/S. Un valor mayor garantizará que no se realice ninguna E/S hasta que se haya acumulado el valor mayor. Esto es útil para garantizar que se usen fragmentos más grandes al realizar E/S. Y suponiendo que hay al menos un byte de datos acumulados un valor de 0 en minSize garantiza que se va a vaciar.
 

[in, optional] asyncContext

Puntero a una estructura de datos WS_ASYNC_CONTEXT con información sobre cómo invocar la función de forma asincrónica. Un valor NULL indica una solicitud de operación sincrónica.

[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
WS_S_ASYNC
 La operación asincrónica sigue pendiente.
WS_E_INVALID_FORMAT
 Los datos de entrada no tenían el formato esperado o no tenían el valor esperado.
E_INVALIDARG
 Uno o más argumentos no son válidos.
E_OUTOFMEMORY
 Se quedó sin memoria.
Otros errores
Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

Esta función es "sin operación" cuando no se establece WS_STREAMED_OUTPUT_TRANSFER_MODE o cuando se usa un escritor XML con WS_XML_WRITER_BUFFER_OUTPUT establecido.

Esta función es un método abreviado para llamar a WsFlushWriter para el escritor XML que se usa para escribir el mensaje. Llamar directamente a WsFlushWriter equivale a llamar a esta función.

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