Compartir a través de

Función WsShutdownSessionChannel (webservices.h)

  • Artículo

Se usa para indicar el final de los mensajes para un canal de sesión.

Sintaxis

HRESULT WsShutdownSessionChannel(
  [in]           WS_CHANNEL             *channel,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parámetros

[in] channel

Canal de sesión que se va a apagar.

[in, optional] asyncContext

Información sobre cómo invocar la función de forma asincrónica o NULL si invoca sincrónicamente.

[in, optional] error

Especifica dónde se debe almacenar información de error adicional 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_E_INVALID_OPERATION
 Se devuelve si el canal no está en el estado WS_CHANNEL_STATE_OPEN .

Comentarios

Esta función indicará a la entidad remota que se han enviado todos los mensajes para el canal.

La entidad remota puede detectar que no hay más mensajes disponibles en el canal buscando el valor devuelto WS_S_END al recibir un mensaje. (Vea Valores devueltos de servicios web de Windows). Sin embargo, los mensajes también pueden dejar de estar disponibles si el canal filtre los mensajes que no son de la aplicación, como se describe en Información general de la capa de canal. El apagado de la sesión se puede distinguir del filtrado de mensajes manteniendo un seguimiento de si se recibieron mensajes anteriores. Si se recibieron mensajes anteriores, se cerró la sesión.

Esta función solo se aplica a los canales creados con un WS_CHANNEL_TYPE con una sesión que admita el envío de mensajes:

El canal debe estar en WS_CHANNEL_STATE_OPEN estado.

Si esta función se ejecuta correctamente, el valor de la propiedad WS_CHANNEL_PROPERTY_IS_SESSION_SHUT_DOWN será TRUE.

Una vez que se ha cerrado un canal de sesión, al intentar enviar un mensaje en el canal o al intentar apagar el canal, se devolverá WS_E_INVALID_OPERATION.

Llamar a esta función es opcional. Cuando se cierra un canal de sesión mediante WsCloseChannel cuando se encuentra en WS_CHANNEL_STATE_OPEN, el canal se apaga automáticamente como parte del proceso de cierre.

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