SetupDiGetHwProfileFriendlyNameExW 関数 (setupapi.h)

SetupDiGetHwProfileFriendlyNameEx 関数は、ローカル コンピューターまたはリモート コンピューター上のハードウェア プロファイル ID に関連付けられているフレンドリ名を取得します。

構文

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExW(
  [in]            DWORD  HwProfile,
  [out]           PWSTR  FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize,
  [in, optional]  PCWSTR MachineName,
                  PVOID  Reserved
);

パラメーター

[in] HwProfile

取得するフレンドリ名に関連付けられているハードウェア プロファイル ID を指定します。 このパラメーターが 0 の場合、現在のハードウェア プロファイルのフレンドリ名が取得されます。

[out] FriendlyName

フレンドリ名を受け取る文字バッファーへのポインター。

[in] FriendlyNameSize

FriendlyName バッファーのサイズ (文字数)。

[out, optional] RequiredSize

フレンドリ名を格納するために必要な文字数を受け取る変数へのポインター (NULL 終端記号を含む)。 このパラメーターは省略可能であり、 NULL にすることができます。

[in, optional] MachineName

ハードウェア プロファイル ID が存在するリモート コンピューターの名前を含む NULL で終わる文字列へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。 MachineName が NULL の場合、ハードウェア プロファイル ID はローカル コンピューター上にあります。

注意事項

この機能は削除されたため、Windows 8 および Windows Server 2012 以降では、この関数を使用してリモート コンピューターにアクセスすることはできません。

Reserved

NULL にする必要があります。

戻り値

成功した場合、この関数は TRUE を 返します。 それ以外の場合は FALSE を 返し、 GetLastError を呼び出すことでログに記録されたエラーを取得できます。

解説

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiGetHwProfileFriendlyNameEx を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

サポートされている最小のクライアント	Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム	デスクトップ
Header	setupapi.h (Setupapi.h を含む)
Library	Setupapi.lib

関連項目

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx