Platform SDK: Windows Sockets

WPUCloseThread

The WPUCloseThread function closes a thread opened with a call to WPUOpenCurrentThread.

INT WSPAPI WPUCloseThread (
  LPWSATHREADID   lpThreadId,   
  LPINT           lpErrno               
);

Parameters

lpThreadId
[in] Pointer to a WSATHREADID structure that identifies the thread context. This structure must have been initialized by a previous call to WPUOpenCurrentThread.
lpErrno
[out] Pointer to the error code.

Return Values

If no error occurs, WPUOpenCurrentThread returns zero. Otherwise, it returns SOCKET_ERROR, and a specific error code is available in lpErrno.

Remarks

The WPUCloseThread function is used in a layered service provider to deallocate the resources that were initiated in a call by the WPUOpenCurrentThread function. The WSATHREADID structure in the lpThreadId is the thread to deallocate.

Every call to WPUOpenCurrentThread must have a call to WPUCloseThread. These two functions are used when the overlapped functions, such as WSPSend, are called in a lower layer of the service provider than the current thread.

Error Codes

Error code Meaning
WSANOTINITIALISED A successful WSPStartup call must occur before using this function.

Requirements

  Version: Requires Windows Sockets 2.0.
  Header: Declared in Ws2spi.h.

See Also

WPUCloseThread, WPUOpenCurrentThread