SetupDiGetHwProfileFriendlyNameA 関数 (setupapi.h)

  • [アーティクル]

SetupDiGetHwProfileFriendlyName 関数は、ハードウェア プロファイル ID に関連付けられているフレンドリ名を取得します。

構文

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize
);

パラメーター

[in] HwProfile

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

[out] FriendlyName

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

[in] FriendlyNameSize

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

[out, optional] RequiredSize

フレンドリ名の取得に必要な文字数 (NULL 終端記号を含む) を受け取る DWORD 型の変数へのポインター。

戻り値

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

注釈

SetupDiGetHwProfileFriendlyNameEx を呼び出して、リモート コンピューター上のハードウェア プロファイル ID のフレンドリ名を取得します。

注意

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

要件

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

こちらもご覧ください

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList