MprConfigGetGuidName function (mprapi.h)

The MprConfigGetGuidName function returns the GUID name for an interface that corresponds to the specified friendly name.

Syntax

DWORD MprConfigGetGuidName(
  [in]  HANDLE hMprConfig,
  [in]  PWSTR  pszFriendlyName,
  [out] PWCHAR pszBuffer,
  [in]  DWORD  dwBufferSize
);

Parameters

[in] hMprConfig

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

[in] pszFriendlyName

Pointer to a Unicode string that specifies the friendly name for the interface.

[out] pszBuffer

Pointer to a buffer that receives the GUID name for the interface.

[in] dwBufferSize

Specifies the size, in bytes, of the buffer pointed to by pszBuffer.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_BUFFER_OVERFLOW
The buffer pointed to by pszBuffer is not large enough to hold the returned GUID name.
ERROR_INVALID_PARAMETER
At least one of the parameters hMprConfig, pszFriendlyName, or pszBuffer is NULL.
ERROR_NOT_FOUND
No GUID name was found that corresponds to the specified friendly name.
 
 

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

MprConfigGetFriendlyName

MprConfigServerConnect

Router Configuration Functions

Router Management Reference