IWDFDeviceInitialize::RetrieveDeviceInstanceId メソッド (wudfddi.h)
[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。
RetrieveDeviceInstanceId メソッドは、デバイスのインスタンスの識別子を取得します。
構文
HRESULT RetrieveDeviceInstanceId(
[out, optional] PWSTR Buffer,
[in, out] DWORD *pdwSizeInChars
);
パラメーター
[out, optional] Buffer
指定されたバッファーが NULL 以外で RetrieveDeviceInstanceId が成功した場合に、デバイスのインスタンスの識別子を表す NULL で終わる文字列を受け取るバッファーへのポインター。
[in, out] pdwSizeInChars
Buffer が指す文字列内の NULL 文字を含む文字数を受け取る変数へのポインター。
Buffer が NULL の場合、ドライバーが提供する値は 0 になります。 その後、フレームワークは、識別子文字列に必要なサイズを文字数で返します。
Buffer が NULL 以外の場合、フレームワークは識別子文字列のサイズを文字単位で返します。
戻り値
RetrieveDeviceInstanceId は 、次のシナリオのS_OKを返します。
- Buffer パラメーターが指すバッファーは NULL 以外で、NULL 文字を含む識別子文字列を保持するのに十分な大きさであり、フレームワークは指定されたバッファーに文字列を正常にコピーし、pdwSizeInChars パラメーターによって指された変数を文字列内の文字数に設定しました。
- Buffer のバッファーは NULL であり、ドライバーは pdwSizeInChars の変数を 0 に事前設定し、フレームワークは pdwSizeInChars の変数を文字列に必要な文字数に設定しました。
RetrieveDeviceInstanceId は、他の HRESULT 値も返す場合があります。
要件
| 要件 | 値 |
|---|---|
| サポート終了 | UMDF 2.0 以降では使用できません。 |
| 対象プラットフォーム | デスクトップ |
| 最小 UMDF バージョン | 1.5 |
| Header | wudfddi.h (Wudfddi.h を含む) |
| [DLL] | WUDFx.dll |