WdfRegistryQueryUnicodeString 関数 (wdfregistry.h)
[KMDF と UMDF に適用]
WdfRegistryQueryUnicodeString メソッドは、指定されたレジストリ文字列値に現在割り当てられている文字列データを取得し、指定した UNICODE_STRING 構造体に文字列をコピーします。
構文
NTSTATUS WdfRegistryQueryUnicodeString(
[in] WDFKEY Key,
[in] PCUNICODE_STRING ValueName,
[out, optional] PUSHORT ValueByteLength,
[in, out] PUNICODE_STRING Value
);
パラメーター
[in] Key
開かれたレジストリ キーを表すレジストリ キー オブジェクトへのハンドル。
[in] ValueName
レジストリ値の名前を含む UNICODE_STRING 構造体へのポインター。
[out, optional] ValueByteLength
Value が指す Unicode 文字列に含まれるバイト数を受け取る場所へのポインター 。終了 NULL バイトも含まれます。 このポインターは省略可能であり、NULL できます
[in, out] Value
key が指定するキーのデータ文字列を受け取る UNICODE_STRING構造体へのポインター。 このパラメーターが NULL で、ValueByteLength が null以外の場合、WdfRegistryQueryUnicodeString は文字列のサイズのみを返します。
戻り値
WdfRegistryQueryUnicodeString 、操作が成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合、メソッドは次のいずれかの値を返す可能性があります。
| リターン コード | 形容 |
|---|---|
|
IRQL = PASSIVE_LEVEL で WdfRegistryQueryUnicodeString が呼び出されませんでした。 |
|
無効なパラメーターが指定されました。 |
|
操作を完了するためのメモリが不足していました。 |
|
ドライバーが、KEY_QUERY_VALUE、KEY_READ、またはKEY_ALL_ACCESSアクセス権を持つレジストリ キーを開けませんでした。 |
|
ValueName パラメーターが指定したレジストリ値のデータ型がREG_SZされませんでした。 |
|
Value パラメーターが指すバッファーが小さすぎて、部分的なデータのみがバッファーに書き込まれた。 |
|
Value パラメーターが指すバッファーが小さすぎて、バッファーにデータが書き込まれなかった。 |
|
レジストリ値を使用できませんでした。 |
このメソッドは、他のNTSTATUS 値を返す場合もあります。
ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。
備考
レジストリ キー オブジェクトの詳細については、「Framework-Based ドライバー でのレジストリの使用」を参照してください。
例
次のコード例は、シリアル サンプル ドライバーから取得され、デバイスのハードウェア キーの下の PortName 値に割り当てられている文字列データを表す Unicode 文字列を取得します。
NTSTATUS
SerialReadSymName(
IN WDFDEVICE Device,
__out PWCHAR RegName,
IN OUT PUSHORT LengthOfRegName // In characters
)
{
NTSTATUS status;
WDFKEY hKey;
UNICODE_STRING value;
UNICODE_STRING valueName;
USHORT requiredLength;
value.Buffer = RegName;
value.MaximumLength = *LengthOfRegName;
value.Length = 0;
status = WdfDeviceOpenRegistryKey(
Device,
PLUGPLAY_REGKEY_DEVICE,
STANDARD_RIGHTS_ALL,
WDF_NO_OBJECT_ATTRIBUTES,
&hKey
);
if (NT_SUCCESS (status)) {
RtlInitUnicodeString(
&valueName,
L"PortName"
);
status = WdfRegistryQueryUnicodeString (
hKey,
&valueName,
&requiredLength,
&value
);
WdfRegistryClose(hKey);
}
return status;
}
必要条件
| 要件 | 価値 |
|---|---|
| ターゲット プラットフォーム の | 万国 |
| 最小 KMDF バージョン | 1.0 |
| UMDF の最小バージョン を する | 2.0 |
| ヘッダー | wdfregistry.h (Wdf.h を含む) |
| ライブラリ | Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF) |
| IRQL | PASSIVE_LEVEL |
| DDI コンプライアンス規則 を する | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |
関連項目
RtlInitUnicodeString を する
WdfRegistryQueryMemory の
WdfRegistryQueryMultiString の
WdfRegistryQueryValue を する