次の方法で共有


SetupDiGetHwProfileFriendlyNameExA 関数 (setupapi.h)

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

構文

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize,
  [in, optional]  PCSTR  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 で使用できます。
ターゲット プラットフォーム の デスクトップ
ヘッダー setupapi.h (Setupapi.h を含む)
ライブラリ Setupapi.lib

関連項目

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx の