MprConfigGetFriendlyName function (mprapi.h)

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

Syntax

DWORD MprConfigGetFriendlyName(
  [in]  HANDLE hMprConfig,
  [in]  PWSTR  pszGuidName,
  [out] PWCHAR pszBuffer,
  [in]  DWORD  dwBufferSize
);

[in] hMprConfig

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

[in] pszGuidName

Pointer to a null-terminated Unicode string that specifies the GUID name for the interface.

[out] pszBuffer

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

[in] dwBufferSize

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

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	One of the following parameters hMprConfig, pszGuidName, or pszBuffer is NULL.
ERROR_NOT_FOUND	No GUID name was found that corresponds to the specified friendly name.

For more information, see Avoiding Buffer Overruns.

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