NSPCleanup (Compact 2013)

3/26/2014

This function terminates the use of a particular Windows Sockets name space service provider.

Syntax

int NSPCleanup(
  LPGUID lpProviderId
);

Parameters

  • lpProviderId
    [in] Pointer to the GUID of the name-space provider that is to be terminated.

Return Value

If no error occurs, this function returns a value of NO_ERROR (zero). Otherwise, SOCKET_ERROR (-1) is returned and the provider must set the appropriate error code using SetLastError.

The following table shows the available error codes.

Value

Description

WSAEINVAL

The lpProviderId does not specify a valid provider.

WSA_NOT_ENOUGH_MEMORY

Not enough free memory available to perform this operation.

Remarks

This function is called when an application is finished using a Windows Sockets name space service provider. The function deregisters a particular name-space provider and allows the transport service provider to free any of the name-space provider's allocated resources.

The NSPStartup function must be called successfully before using any name-space providers. It is permissible to make more than one NSPStartup call. However, for each call, a corresponding NSPCleanup call must also be issued. Only the final NSPCleanup for the service provider does the actual cleanup; the preceding calls simply decrement an internal reference count in the service provider.

This function should not return until the name space service provider DLL can be unloaded from memory.

Requirements

Header

ws2spi.h

Library

Ws2.lib

See Also

Reference

Winsock SPI Functions
NSPStartup