Функция WPUQuerySocketHandleContext (ws2spi.h)

  • Статья

Функция WPUQuerySocketHandleContext запрашивает значение контекста, связанное с указанным дескриптором сокета.

Синтаксис

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

Параметры

[in] s

Описание, определяющее сокет, контекст которого требуется запросить.

[out] lpContext

Указатель, который получит значение контекста.

[out] lpErrno

Указатель на код ошибки.

Возвращаемое значение

Если ошибка не возникает, WPUQuerySocketHandleContext возвращает ноль и сохраняет текущее значение контекста в lpContext. В противном случае возвращается SOCKET_ERROR, и в lpErrno доступен определенный код ошибки.

Код ошибки Значение
WSAENOTSOCK
 Дескриптор не является сокетом, созданным WPUCreateSocketHandle.
 
 

Комментарии

Функция WPUQuerySocketHandleContext запрашивает текущее значение контекста, связанное с указанным дескриптором сокета. Поставщики услуг обычно используют эту функцию для получения указателя на данные конкретного поставщика, связанные с сокетом. Например, поставщик услуг может использовать контекст сокета для хранения указателя на структуру, содержащую состояние сокета, локальные и удаленные транспортные адреса, а также объекты событий для сигнализации сетевых событий.

Эту функцию используют только поставщики, отличные от IFS, так как поставщики IFS не могут предоставить контекстное значение.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header ws2spi.h

См. также раздел

WPUCreateSocketHandle