WebSocketBeginClientHandshake-Funktion (websocket.h)

Die WebSocketBeginClientHandshake-Funktion beginnt den clientseitigen Handshake.

Syntax

HRESULT WebSocketBeginClientHandshake(
  [in]           WEB_SOCKET_HANDLE             hWebSocket,
  [in, optional] PCSTR                         *pszSubprotocols,
  [in]           ULONG                         ulSubprotocolCount,
  [in, optional] PCSTR                         *pszExtensions,
  [in]           ULONG                         ulExtensionCount,
  [in, optional] const PWEB_SOCKET_HTTP_HEADER pInitialHeaders,
  [in]           ULONG                         ulInitialHeaderCount,
  [out]          PWEB_SOCKET_HTTP_HEADER       *pAdditionalHeaders,
  [out]          ULONG                         *pulAdditionalHeaderCount
);

Parameter

[in] hWebSocket

Typ: WEB_SOCKET_HANDLE

WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateClientHandle zurückgegeben wurde.

[in, optional] pszSubprotocols

Typ: PCSTR*

Zeiger auf ein Array von Unterprotokollen, die von der Anwendung ausgewählt werden. Sobald der Client-Server-Handshake abgeschlossen ist, muss die Anwendung das von WebSocketEndClientHandshake zurückgegebene Unterprotokoll verwenden. Muss ein Unterprotokoll pro Eintrag enthalten.

[in] ulSubprotocolCount

Typ: ULONG

Anzahl der Unterprotokolle in pszSubprotocols.

[in, optional] pszExtensions

Typ: PCSTR*

Zeiger auf ein Array von Erweiterungen, das von der Anwendung ausgewählt wurde. Nachdem der Client-Server-Handshake abgeschlossen ist, muss die Anwendung die erweiterung verwenden, die von WebSocketEndClientHandshake zurückgegeben wird. Muss eine Erweiterung pro Eintrag enthalten.

[in] ulExtensionCount

Typ: ULONG

Anzahl der Erweiterungen in pszExtensions.

[in, optional] pInitialHeaders

Typ: const PWEB_SOCKET_HTTP_HEADER

Zeiger auf ein Array von WEB_SOCKET_HTTP_HEADER Strukturen, die die von der Anwendung zu sendenden Anforderungsheader enthalten. Das Array muss den Host-HTTP-Header enthalten, wie in RFC 2616 definiert.

[in] ulInitialHeaderCount

Typ: ULONG

Anzahl der Anforderungsheader in pInitialHeaders.

[out] pAdditionalHeaders

Typ: PWEB_SOCKET_HTTP_HEADER

Zeigen Sie bei erfolgreicher Ausgabe auf ein Array von WEB_SOCKET_HTTP_HEADER Strukturen, die die von der Anwendung zu sendenden Anforderungsheader enthalten. Wenn einer dieser Header in pInitialHeaders angegeben wurde, muss der Header ersetzt werden.

[out] pulAdditionalHeaderCount

Typ: ULONG*

Bei erfolgreicher Ausgabe anzahl der Antwortheader in pAdditionalHeaders.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, wird S_OK zurückgegeben.

Wenn die Funktion fehlschlägt, gibt sie einen in WinError.h definierten Systemfehlercode zurück.

Hinweise

Um den clientseitigen Handshake abzuschließen, müssen Anwendungen WebSocketEndClientHandshake aufrufen. Sobald der Client-Server-Handshake abgeschlossen ist, kann die Anwendung die Sitzungsfunktionen verwenden.

Anforderungen

Weitere Informationen

WEB_SOCKET_HTTP_HEADER

WebSocketBeginServerHandshake

WebSocketEndClientHandshake

WebSocketEndServerHandshake