MprConfigGetFriendlyName 函数 (mprapi.h)

MprConfigGetFriendlyName 函数返回与指定 GUID 名称对应的接口的友好名称。

语法

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

[in] hMprConfig

路由器配置的句柄。通过调用 MprConfigServerConnect 获取此句柄。

[in] pszGuidName

指向以 null 结尾的 Unicode 字符串的指针，该字符串指定接口的 GUID 名称。

[out] pszBuffer

指向接收接口友好名称的缓冲区的指针。

[in] dwBufferSize

指定 pszBuffer 指向的缓冲区的大小（以字节为单位）。

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

值	含义
ERROR_BUFFER_OVERFLOW	pszBuffer 指向的缓冲区不够大，无法容纳返回的 GUID 名称。
ERROR_INVALID_PARAMETER	以下参数之一 hMprConfig、 pszGuidName 或 pszBuffer 为 NULL。
ERROR_NOT_FOUND	找不到与指定的友好名称相对应的 GUID 名称。

有关详细信息，请参阅避免缓冲区溢出。