WinHttpWebSocketCompleteUpgrade-Funktion (winhttp.h)

  • Artikel

Die WinHttpWebSocketCompleteUpgrade-Funktion schließt einen WebSocket-Handshake ab, der von WinHttpSendRequest gestartet wurde.

Syntax

WINHTTPAPI HINTERNET WinHttpWebSocketCompleteUpgrade(
  [in]           HINTERNET hRequest,
  [in, optional] DWORD_PTR pContext
);

Parameter

[in] hRequest

Typ: HINTERNET

HTTP-Anforderungshandle zum Senden eines WebSocket-Handshakes.

[in, optional] pContext

Typ: DWORD_PTR

Kontext, der dem neuen Handle zugeordnet werden soll.

Rückgabewert

Typ: HINTERNET

Ein neues WebSocket-Handle. Wenn NULL, rufen Sie GetLastError auf, um die Fehlerursache zu ermitteln.

Hinweise

WinHttpWebSocketCompleteUpgrade kann für eine offene HTTP-Anforderung aufgerufen werden, um ein WebSocket-Handle zum Ausführen anderer WebSocket-Vorgänge abzurufen.

Das Anforderungshandle muss als WebSocket-Upgrade gekennzeichnet werden, indem WinHttpSetOption mit WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET aufgerufen wird, bevor die Anforderung gesendet wird.

Der Aufrufer sollte den vom Server zurückgegebenen HTTP-status-Code überprüfen und diese Funktion nur aufrufen, wenn der status Code 101 lautet. Das Aufrufen mit einem anderen status Code führt zu einem Fehler.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile winhttp.h
Bibliothek Winhttp.lib
DLL Winhttp.dll