WsShutdownSessionChannel-Funktion (webservices.h)

  • Artikel

Wird verwendet, um das Ende von Nachrichten für einen Sitzungskanal zu signalisieren.

Syntax

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

Parameter

[in] channel

Der herunterzufahrende Sitzungskanal.

[in, optional] asyncContext

Informationen zum asynchronen Aufrufen der Funktion oder NULL beim synchronen Aufruf.

[in, optional] error

Gibt an, wo zusätzliche Fehlerinformationen gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
WS_E_INVALID_OPERATION
 Dies wird zurückgegeben, wenn sich der Kanal nicht im WS_CHANNEL_STATE_OPEN Zustand befindet.

Hinweise

Diese Funktion gibt der Remotepartei an, dass alle Nachrichten für den Kanal gesendet wurden.

Die Remotepartei kann erkennen, dass keine weiteren Nachrichten im Kanal verfügbar sind, indem sie beim Empfang einer Nachricht nach dem WS_S_END Rückgabewert sucht. (Siehe Rückgabewerte für Windows-Webdienste.) Nachrichten können jedoch auch nicht mehr verfügbar sein, wenn die Nichtanwendungsnachrichten nach dem Kanal gefiltert wurden, wie unter Übersicht über Kanalebene beschrieben. Das Herunterfahren der Sitzung kann von der Nachrichtenfilterung unterschieden werden, indem nachverfolgt wird, ob vorherige Nachrichten empfangen wurden. Wenn vorherige Nachrichten empfangen wurden, wurde die Sitzung beendet.

Diese Funktion gilt nur für Kanäle, die mit einem WS_CHANNEL_TYPE mit einer Sitzung erstellt wurden, die das Senden von Nachrichten unterstützt:

Der Kanal muss sich in WS_CHANNEL_STATE_OPEN Zustand befinden.

Wenn diese Funktion erfolgreich ist, ist der Wert der eigenschaft WS_CHANNEL_PROPERTY_IS_SESSION_SHUT_DOWNtrue.

Nachdem ein Sitzungskanal heruntergefahren wurde, wird der Versuch, eine Nachricht auf dem Kanal zu senden oder den Kanal herunterzufahren, WS_E_INVALID_OPERATION zurückgegeben.

Der Aufruf dieser Funktion ist optional. Wenn ein Sitzungskanal in WS_CHANNEL_STATE_OPEN mit WsCloseChannel geschlossen wird, wird der Kanal automatisch im Rahmen des Schließens heruntergefahren.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile webservices.h
Bibliothek WebServices.lib
DLL WebServices.dll