SetupDiGetHwProfileFriendlyNameExA 函式 (setupapi.h)

  • 發行項

SetupDiGetHwProfileFriendlyNameEx 函式會擷取與本機或遠端電腦上硬體配置檔標識符相關聯的易記名稱。

語法

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

參數

[in] HwProfile

提供與要擷取之易記名稱相關聯的硬體配置檔標識碼。 如果此參數為 0，則會擷取目前硬體配置檔的易記名稱。

[out] FriendlyName

要接收易記名稱之字元緩衝區的指標。

[in] FriendlyNameSize

FriendlyName 緩衝區的大小，以字元為單位。

[out, optional] RequiredSize

要接收儲存易記名稱所需字元數的變數指標， (包括 NULL 終止符) 。 這個參數是選擇性的，而且可以是 NULL。

[in, optional] MachineName

NULL 終止字串的指標，其中包含硬體配置檔識別元所在遠端電腦的名稱。 這個參數是選擇性的，而且可以是 NULL。 如果 MachineName 為 NULL，硬體設定檔識別碼會位於本機電腦上。

警告

從 Windows 8 和 Windows Server 2012 開始，不支援使用此函式來存取遠端計算機，因為此功能已移除。

Reserved

必須是 NULL。

傳回值

如果函式成功，函式會傳回 TRUE 。 否則，它會傳回 FALSE ，而且可以藉由呼叫 GetLastError 來擷取記錄的錯誤。

備註

注意

setupapi.h 標頭會根據 UNICODE 預處理器常數的定義，將 SetupDiGetHwProfileFriendlyNameEx 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 可在 Microsoft Windows 2000 和更新版本的 Windows 中使用。
目標平台 桌面
標頭 setupapi.h (包括 Setupapi.h)
程式庫 Setupapi.lib

另請參閱

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx