SHRegQueryUSValueA 関数 (shlwapi.h)

[アーティクル]
11/20/2024

ユーザー固有のサブツリー (HKEY_CURRENT_USERまたはHKEY_LOCAL_MACHINE) の開いているレジストリサブキーに関連付けられている指定した名前の型とデータを取得します。

構文

LSTATUS SHRegQueryUSValueA(
  [in]                HUSKEY hUSKey,
  [in, optional]      LPCSTR pszValue,
  [in, out, optional] DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out]           DWORD  *pcbData,
  [in]                BOOL   fIgnoreHKCU,
  [in, optional]      void   *pvDefaultData,
  [in, optional]      DWORD  dwDefaultDataSize
);

パラメーター

[in] hUSKey

型: ハスキー

現在開いているレジストリサブキーへのハンドル、または次の定義済みの値のいずれか。サブキーは、KEY_SET_VALUEアクセス権で開かれている必要があります。詳細については、「レジストリキーのセキュリティとアクセス権のをする」を参照してください。

このハンドルは、SHRegOpenUSKey 関数を使用して取得できます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszValue

型: LPCTSTR

nullクエリ対象の値の名前を含む終端文字列へのポインター。

[in, out, optional] pdwType

型: LPDWORD*

キーの値型を設定または受け取る変数へのポインター。詳細については、「レジストリデータ型の」を参照してください。このパラメーターは NULLできます。

[out, optional] pvData

型: LPVOID*

値のデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターは NULL できます。

[in, out] pcbData

型: LPDWORD*

pvData パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。関数から制御が戻ると、この変数には、pvDataにコピーデータのサイズが格納されます。

[in] fIgnoreHKCU

型: BOOL

検索するキーを指定する変数。 TRUEに設定すると、SHRegQueryUSValue は HKEY_CURRENT_USER を無視し、HKEY_LOCAL_MACHINEの下のキーから値を返します。

[in, optional] pvDefaultData

型: LPVOID*

既定のデータへのポインター。

[in, optional] dwDefaultDataSize

型: DWORD

既定のデータの長さ (バイト単位)。

戻り値

型: LSTATUS

成功した場合はERROR_SUCCESSを返し、それ以外の場合は Winerror.h で定義された 0 以外のエラーコードを返します。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用して、エラーの一般的な説明を取得できます。

備考

fIgnoreHKCU が TRUEに設定されている場合、SHRegQueryUSValue は、HKEY_LOCAL_MACHINEの下のキーから値を返。 FALSEをに設定すると、SHRegQueryUSValue 最初に HKEY_CURRENT_USERのキーから値を返そうとします。ただし、HKEY_CURRENT_USERの下にキーが見つからない場合は、HKEY_LOCAL_MACHINEの下のキーから値が返されます。どちらのキーも存在しない場合、またはエラーが発生し、dwDefaultDataSize が 0 以外の場合は、既定のデータ pvData にコピーされ、ERROR_SUCCESSが返されます。 ERROR_SUCCESSは、既定のデータと既定以外のデータの両方に対して返され、pvDataコピーする値を区別する方法はありません。既定のデータを使用しないようにするには、pvDefaultData NULL に設定し、dwDefaultDataSize を 0 にします。

1 つの値のみを読み取る必要がある場合は、SHRegGetUSValue キーを開き、値を返します。 SHRegQueryUSValue使用するには、最初に SHRegOpenUSKeyキーを開く必要があります。ただし、キーを開くと、必要な回数だけ SHRegQueryUSValue 使用できます。同じキーから複数の値を取得する必要がある場合、SHRegQueryUSValue をするために複数の呼び出しを使用すると、通常、キーが 1 回だけ開かれるので、SHRegGetUSValueよりも効率的です。

手記

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

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional、Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	shlwapi.h
ライブラリ	Shlwapi.lib
DLL	Shlwapi.dll (バージョン 4.71 以降)

次の方法で共有