WPUGetProviderPath function (ws2spi.h)

Article
02/22/2024

The WPUGetProviderPath function retrieves the DLL path for the specified provider.

Syntax

int WPUGetProviderPath(
  [in]      LPGUID lpProviderId,
  [out]     WCHAR  *lpszProviderDllPath,
  [in, out] LPINT  lpProviderDllPathLen,
  [out]     LPINT  lpErrno
);

Parameters

[in] lpProviderId

Locally unique identifier of the provider. This must be a value obtained by using WSCEnumProtocols.

[out] lpszProviderDllPath

Pointer to a buffer containing a string that identifies the provider DLL's path. This path is a null-terminated string and any embedded environment strings (such as %SystemRoot%) have not been expanded.

[in, out] lpProviderDllPathLen

Size of the buffer pointed to by lpszProviderDllPath, in characters.

[out] lpErrno

Pointer to the error code.

Return value

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

Error code	Meaning
WSAEINVAL	The lpProviderId parameter does not specify a valid provider.
WSAEFAULT	Either lpszProviderDllPath or lpErrno is not in a valid part of the user address space, or lpProviderDllPathLen is too small.

Remarks

The WPUGetProviderPath function retrieves the DLL path for the specified provider. The DLL path is null-terminated and may contain embedded environment strings (such as %SystemRoot%). Thus, the string should be expanded prior to being used with LoadLibrary. For more information, see LoadLibrary.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ws2spi.h