MprConfigGetFriendlyName

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

DWORD MprConfigGetFriendlyName(
  HANDLE hMprConfig,   // handle to router configuration
  PWCHAR pszGuidName,  // GUID name for the interface
  PWCHAR pszBuffer,    // buffer to receive friendly name
  DWORD dwBufferSize   // size of buffer passed in 
);

Parameters

hMprConfig
[in] Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
pszGuidName
[in] Pointer to a Unicode string that specifies the GUID name for the interface.
pszBuffer
[out] Pointer to a buffer that receives the friendly name for the interface.
dwBufferSize
[in] Specifies the size, in bytes, of the buffer pointed to by pszBuffer.

Return Values

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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Configuration Functions, MprConfigGetGuidName, MprConfigServerConnect