SetupDiGetDeviceInstanceIdA 関数 (setupapi.h)

SetupDiGetDeviceInstanceId 関数は、デバイス情報要素に関連付けられているデバイス インスタンス ID を取得します。

注意

Windows Vista 以降のバージョンの Windows では、 統合デバイス プロパティ モデル では 、DEVPKEY_Device_InstanceIdプロパティ キー を使用してデバイス インスタンス識別子を表します。 詳細については、「 デバイス インスタンス識別子の取得 」を参照してください。

構文

WINSETUPAPI BOOL SetupDiGetDeviceInstanceIdA(
  [in]            HDEVINFO         DeviceInfoSet,
  [in]            PSP_DEVINFO_DATA DeviceInfoData,
  [out, optional] PSTR             DeviceInstanceId,
  [in]            DWORD            DeviceInstanceIdSize,
  [out, optional] PDWORD           RequiredSize
);

パラメーター

[in] DeviceInfoSet

デバイス インスタンス ID を取得するデバイスを表すデバイス情報要素を含むデバイス情報 セット へのハンドル。

[in] DeviceInfoData

DeviceInfoSet のデバイス情報要素を指定するSP_DEVINFO_DATA構造体へのポインター。

[out, optional] DeviceInstanceId

指定したデバイス情報要素の NULL で終わるデバイス インスタンス ID を受け取る文字バッファーへのポインター。 デバイス インスタンス ID の詳細については、「 デバイス識別文字列」を参照してください。

[in] DeviceInstanceIdSize

DeviceInstanceId バッファーのサイズ (文字単位)。

[out, optional] RequiredSize

デバイス インスタンス ID の格納に必要な文字数を受け取る変数へのポインター。

戻り値

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

解説

注意

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

要件

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

関連項目

SP_DEVINFO_DATA

SetupDiCreateDevRegKey

SetupDiCreateDeviceInfo

SetupDiOpenDevRegKey

SetupDiOpenDeviceInfo