Поделиться через

Функция WsShutdownSessionChannel (webservices.h)

  • Статья

Используется для обозначения конца сообщений для канала сеанса.

Синтаксис

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

Параметры

[in] channel

Канал сеанса для завершения работы.

[in, optional] asyncContext

Сведения о том, как вызвать функцию асинхронно или null при синхронном вызове.

[in, optional] error

Указывает, где должны храниться дополнительные сведения об ошибке в случае сбоя функции.

Возвращаемое значение

Эта функция может возвращать одно из этих значений.

Код возврата Описание
WS_E_INVALID_OPERATION
 Возвращается, если канал не находится в состоянии WS_CHANNEL_STATE_OPEN .

Комментарии

Эта функция указывает удаленной стороне, что все сообщения отправлены для канала.

Удаленная сторона может обнаружить, что в канале больше нет доступных сообщений, выполнив поиск возвращаемого значения WS_S_END при получении сообщения. (См. раздел Возвращаемые значения веб-служб Windows.) Однако сообщения также могут стать недоступными, если сообщения, не относящиеся к приложению, были отфильтрованы по каналу, как описано в разделе Общие сведения об уровне канала. Завершение сеанса можно отличить от фильтрации сообщений, отслеживая, были ли получены предыдущие сообщения. Если предыдущие сообщения были получены, сеанс был закрыт.

Эта функция применяется только к каналам, созданным с помощью WS_CHANNEL_TYPE с сеансом, поддерживающим отправку сообщений:

Канал должен находиться в состоянии WS_CHANNEL_STATE_OPEN .

Если эта функция выполнена успешно, свойство WS_CHANNEL_PROPERTY_IS_SESSION_SHUT_DOWN будет иметь значение TRUE.

После завершения сеансового канала попытка отправить сообщение на канал или завершить работу канала вернет WS_E_INVALID_OPERATION.

Вызов этой функции необязателен. Если канал сеанса закрывается с помощью WsCloseChannel в WS_CHANNEL_STATE_OPEN, канал автоматически завершает работу в рамках процесса закрытия.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header webservices.h
Библиотека WebServices.lib
DLL WebServices.dll