Função WinHttpWebSocketCompleteUpgrade (winhttp.h)

A função WinHttpWebSocketCompleteUpgrade conclui um handshake WebSocket iniciado por WinHttpSendRequest.

Sintaxe

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

Parâmetros

[in] hRequest

Tipo: HINTERNET

Identificador de solicitação HTTP usado para enviar um handshake WebSocket.

[in, optional] pContext

Tipo: DWORD_PTR

Contexto a ser associado ao novo identificador.

Valor retornado

Tipo: HINTERNET

Um novo identificador WebSocket. Se FOR NULL, chame GetLastError para determinar a causa da falha.

Comentários

WinHttpWebSocketCompleteUpgrade pode ser chamado em uma solicitação HTTP aberta para obter um identificador WebSocket para executar outras operações do WebSocket.

O identificador de solicitação deve ser marcado como uma atualização do WebSocket chamando WinHttpSetOption com WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET antes de enviar a solicitação.

O chamador deve marcar o código de status HTTP retornado pelo servidor e chamar essa função somente se o código de status for 101. Chamá-lo com qualquer outro código status resultará em uma falha.

Requisitos

Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winhttp.h
Biblioteca	Winhttp.lib
DLL	Winhttp.dll