WinHttpWebSocketCompleteUpgrade 函数 (winhttp.h)
WinHttpWebSocketCompleteUpgrade 函数完成由 WinHttpSendRequest 启动的 WebSocket 握手。
语法
WINHTTPAPI HINTERNET WinHttpWebSocketCompleteUpgrade(
[in] HINTERNET hRequest,
[in, optional] DWORD_PTR pContext
);
参数
[in] hRequest
类型: HINTERNET
用于发送 WebSocket 握手的 HTTP 请求句柄。
[in, optional] pContext
类型: DWORD_PTR
要与新句柄关联的上下文。
返回值
类型: HINTERNET
新的 WebSocket 句柄。 如果为 NULL,则调用 GetLastError 以确定失败原因。
注解
可以对打开的 HTTP 请求调用 WinHttpWebSocketCompleteUpgrade,以获取用于执行其他 WebSocket 操作的 WebSocket 句柄。
发送请求之前,必须通过调用具有 WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET 的 WinHttpSetOption,将请求句柄标记为 WebSocket 升级。
调用方应检查服务器返回的 HTTP 状态代码,并且仅在状态代码为 101 时调用此函数。 使用任何其他状态代码调用它将导致失败。
要求
最低受支持的客户端 | Windows 8 [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2012 [仅限桌面应用] |
目标平台 | Windows |
标头 | winhttp.h |
Library | Winhttp.lib |
DLL | Winhttp.dll |