CM_Get_Device_ID_List_SizeW関数 (cfgmgr32.h)

  • [アーティクル]

CM_Get_Device_ID_List_Size関数は、ローカル コンピューターのデバイス インスタンスのデバイス インスタンス ID の一覧を保持するために必要なバッファー サイズを取得します。

構文

CMAPI CONFIGRET CM_Get_Device_ID_List_SizeW(
  [out]          PULONG pulLen,
  [in, optional] PCWSTR pszFilter,
  [in]           ULONG  ulFlags
);

パラメーター

[out] pulLen

必要なバッファー サイズを表す値を文字で受け取ります。

[in, optional] pszFilter

マシンのデバイス インスタンス識別子のサブセット ( NULL) を指定する文字列への呼び出し元指定ポインター。 ulFlags の次の説明を参照してください。

[in] ulFlags

検索フィルターを指定する、呼び出し元から提供される省略可能なビット フラグの 1 つ。 フラグが指定されていない場合、関数は、すべてのデバイス インスタンスのすべてのインスタンス識別子を保持するために必要なバッファー サイズを提供します。 ビット フラグの一覧については、CM_Get_Device_ID_Listの ulFlags の説明を参照してください。

戻り値

操作が成功した場合、関数はCR_SUCCESSを返します。 それ以外の場合は、 Cfgmgr32.h で定義されているCR_プレフィックス付きのエラー コードのいずれかを返します。

注釈

CM_Get_Device_ID_List_Size関数を呼び出して、CM_Get_Device_ID_Listに必要なバッファー サイズを決定する必要があります。

pulLen が指す場所に指定されたサイズ値は、すべてのデバイス インスタンス識別子文字列を保持し、NULL を終了するのに十分な大きさのバッファー サイズを表す必要があります。 指定された値は、実際には必要以上のバッファー サイズを表している可能性があるため、値が CM_Get_Device_ID_List が提供する文字列の実際の長さを表すと想定しないでください。

デバイス インスタンス ID の詳細については、「 デバイス識別文字列」を参照してください。

注意

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

要件

要件 値
サポートされている最小のクライアント Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム ユニバーサル
Header cfgmgr32.h (Cfgmgr32.h を含む)
Library Cfgmgr32.lib
[DLL] CfgMgr32.dll

こちらもご覧ください

CM_Get_Device_ID_List_Size_Ex