MprConfigGetFriendlyName 函式 (mprapi.h)

MprConfigGetFriendlyName 函式會傳回對應至指定 GUID 名稱之介面的易記名稱。

語法

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

[in] hMprConfig

路由器組態的句柄。藉由呼叫 MprConfigServerConnect 來取得此句柄。

[in] pszGuidName

指定介面 GUID 名稱 之 Null 終止 Unicode 字串的指標。

[out] pszBuffer

接收介面易記名稱之緩衝區的指標。

[in] dwBufferSize

指定 pszBuffer 所指向之緩衝區的大小，以位元組為單位。

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

值	意義
ERROR_BUFFER_OVERFLOW	pszBuffer 所指向的緩衝區不夠大，無法保存傳回的 GUID 名稱。
ERROR_INVALID_PARAMETER	下列其中一個參數 hMprConfig、 pszGuidName 或 pszBuffer 為 NULL。
ERROR_NOT_FOUND	找不到對應至指定易記名稱的 GUID 名稱。