指定したレジストリキーの値を読み取ります。
定義
Declare Function RegQueryValueEx Lib "advapi32" Alias "RegQueryValueExA" _
(hKey As HKEY, _
lpValueName As String, _
lpReserved As DWord, _
lpType As DWordPtr, _
lpData As VoidPtr, _
lpcbData As DWordPtr) As Long
hKey
既存のキーのハンドルを指定します。以下の定義済みハンドルから指定することもできます。
ハンドル | 説明 |
HKEY_CLASSES_ROOT | 拡張子に関する情報、Windowsにインストールされているコンポーネントに関する情報などが格納されています。 |
HKEY_CURRENT_USER | 現在のユーザーが使用するためのOS、アプリケーションに関する情報などが格納されています。 |
HKEY_LOCAL_MACHINE | コンピュータ固有の情報などが格納されています。 |
HKEY_USERS | すべてのユーザーに関する情報などが格納されています。 |
lpValueName
読み取る値の名前を指定します。
lpReserved
予約されています。0 を指定して下さい。
lpType
32 ビット整数型変数へのポインタを指定します。ここで指定する変数に、データの種類が以下の定数から格納されます。不要なときは、NULL を指定することができます。
定数 | 説明 |
REG_BINARY | 任意の形式のバイナリデータです。 |
REG_DWORD 、または REG_DWORD_LITTLE_ENDIAN | 32 ビット値です。 |
REG_DWORD_BIG_ENDIAN | ビッグエンディアン形式の 32 ビット値です。 |
REG_EXPAND_SZ | 展開前の環境変数への参照 (たとえば "%PATH%" ) が入った NULL で終わる文字列です。 |
REG_LINK | Unicode のシンボリックリンクです。 |
REG_MULTI_SZ | NULL で終わる文字列の配列です。連続する 2 つの NULL 文字で、終端を示します。 |
REG_NONE | 定義されていない種類です。 |
REG_RESOURCE_LIST | デバイスドライバのリソースリストです。 |
REG_SZ | NULL で終わる文字列です。 |
lpData
読み取ったデータを受け取るためのバッファへのポインタを指定します。不要なときは、NULL を指定することができます。
lpcbData
lpData パラメータで指定したバッファのバイト数が格納されている、32 ビット整数型変数へのポインタを指定します。関数が成功すると、読み取ったデータのバイト数が格納されます。lpData パラメータに NULL を指定すると、必要なバイト数が格納されます。lpData パラメータに NULL を指定したときに限り、このパラメータに NULL を指定することができます。
戻り値
関数が成功すると、ERROR_SUCCESS が返ります。失敗すると、0 以外の値のエラーコードが返ります。
解説
hKey パラメータで指定するキーは、KEY_QUERY_VALUE 権を持っていなければなりません。
環境情報
インクルード ファイル: api_reg.sbp 内で定義済み
DLLファイル: advapi32.dll
RegCreateKeyEx関数、RegOpenKeyEx関数、RegSetValueEx関数