Platform SDK: Windows Sockets

WPUQuerySocketHandleContext

The WPUQuerySocketHandleContext function queries the context value associated with the specified socket handle.

int WPUQuerySocketHandleContext (
  SOCKET      s,            
  LPDWORD     lpContext,   
  LPINT       lpErrno        
);

Parameters

s: [in] Descripton identifying the socket whose context is to be queried.
lpContext: [out] Pointer that will receive the context value.
lpErrno: [out] Pointer to the error code.

Return Values

If no error occurs, WPUQuerySocketHandleContext returns zero and stores the current context value in lpContext. Otherwise, it returns SOCKET_ERROR, and a specific error code is available in lpErrno.

Remarks

The WPUQuerySocketHandleContext function queries the current context value associated with the specified socket handle. Service providers typically use this function to retrieve a pointer to provider-specific data associated with the socket. For example, a service provider can use the socket context to store a pointer to a structure containing the socket's state, local and remote transport addresses, and event objects for signaling network events.

This function is only used by non-IFS providers since IFS providers are not able to supply a context value.

Error Codes

Error code	Meaning
WSAENOTSOCK	Descriptor is not a socket created by WPUCreateSocketHandle.

Requirements