WSCInstallNameSpace

The WSCInstallNameSpace function installs a name-space provider. For providers that are able to support multiple names spaces, this function must be called once for every name space supported, and a unique provider identifier must be supplied each time.

int WSCInstallNameSpace (
  LPWSTR    lpszIdentifier,   
  LPWSTR    lpszPathName,   
  DWORD     dwNameSpace,     
  DWORD     dwVersion,       
  LPGUID    lpProviderId    
);

Parameters

lpszIdentifier

[in] Pointer to a string that identifies the provider for use in the GUID.

lpszPathName

[in] Pointer to a string that contains the path to the provider's DLL image. The string observes the usual rules for path resolution: this path can contain embedded environment strings (such as %SystemRoot%). Such environment strings are expanded whenever the Ws2_32.dll needs to subsequently load the provider DLL on behalf of an application. After any embedded environment strings are expanded, the Ws2_32.dll passes the resulting string into the LoadLibrary function to load the provider into memory. For more information, see LoadLibrary.

dwNameSpace

[in] Descriptor that specifies the name space supported by this provider.

dwVersion

[in] Descriptor that specifies the version number of the provider.

lpProviderId

[in] Unique identifier for this provider. This GUID should be generated by Uuidgen.exe.

Return Values

If no error occurs, the WSCInstallNameSpace function returns NO_ERROR (zero). Otherwise, it returns SOCKET_ERROR if the function fails, and it must set the appropriate error code using SetLastError.

Remarks

The name space configuration functions do not affect applications that are already running. Newly installed name-space providers will not be visible to applications nor will the changes in a name-space provider's activation state. Applications launched after the call to WSCInstallNameSpace will see the changes.

Error Codes

Requirements

  Version: Requires Windows Sockets 2.0.
  Header: Declared in Ws2spi.h.
  Library: Use Ws2_32.lib.