Função WPUQuerySocketHandleContext (ws2spi.h)

A função WPUQuerySocketHandleContext consulta o valor de contexto associado ao identificador de soquete especificado.

Sintaxe

int WPUQuerySocketHandleContext(
  [in]  SOCKET     s,
  [out] PDWORD_PTR lpContext,
  [out] LPINT      lpErrno
);

Parâmetros

[in] s

Descrição que identifica o soquete cujo contexto deve ser consultado.

[out] lpContext

Ponteiro que receberá o valor de contexto.

[out] lpErrno

Ponteiro para o código de erro.

Retornar valor

Se nenhum erro ocorrer, WPUQuerySocketHandleContext retornará zero e armazenará o valor de contexto atual em lpContext. Caso contrário, ele retornará SOCKET_ERROR e um código de erro específico estará disponível em lpErrno.

Código do erro	Significado
WSAENOTSOCK	O descritor não é um soquete criado por WPUCreateSocketHandle.

 

 

Comentários

A função WPUQuerySocketHandleContext consulta o valor de contexto atual associado ao identificador de soquete especificado. Os provedores de serviço normalmente usam essa função para recuperar um ponteiro para dados específicos do provedor associados ao soquete. Por exemplo, um provedor de serviços pode usar o contexto de soquete para armazenar um ponteiro para uma estrutura que contém o estado do soquete, endereços de transporte local e remoto e objetos de evento para sinalizar eventos de rede.

Somente provedores não IFS usam essa função, pois os provedores IFS não são capazes de fornecer um valor de contexto.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ws2spi.h

Confira também

Wpucreatesockethandle