RegSetValueA 関数 (winreg.h)

[アーティクル]
08/27/2023

指定したレジストリキーの既定値または名前のない値のデータを設定します。データはテキスト文字列である必要があります。

メモこの関数は、16 ビットバージョンの Windows との互換性のためにのみ提供されます。アプリケーションでは、RegSetValueEx 関数を使用する必要があります。

構文

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR lpData,
  [in]           DWORD  cbData
);

パラメーター

[in] hKey

開いているレジストリキーへのハンドル。キーは、KEY_SET_VALUEアクセス権を使用して開かれている必要があります。詳細については、「レジストリキーのセキュリティとアクセス権」を参照してください。

このハンドルは、 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次の定義済みキーのいずれかを指定することもできます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

hKey パラメーターのサブキーの名前。関数は、指定したサブキーの既定値を設定します。 lpSubKey が存在しない場合、関数によって作成されます。

キー名では大文字と小文字は区別されません。

このパラメーターが NULL であるか、空の文字列を指している場合、関数は hKey で識別されるキーの既定値を設定します。

詳細については、「レジストリ要素のサイズ制限」を参照してください。

[in] dwType

格納する情報の種類。このパラメーターは、REG_SZ型である必要があります。他のデータ型を格納するには、 RegSetValueEx 関数を使用します。

[in] lpData

格納するデータ。このパラメーターを NULL にすることはできません。

[in] cbData

このパラメーターは無視されます。この関数は、 lpData パラメーター内のデータのサイズに基づいてこの値を計算します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。

注釈

lpSubKey パラメーターで指定されたキーが存在しない場合は、RegSetValue 関数によって作成されます。

この関数の ANSI バージョンを使用する場合 ( RegSetValueA を明示的に呼び出すか、Windows.h ファイルを含める前に UNICODE を定義しない場合)、 lpData パラメーターは ANSI 文字列である必要があります。文字列は、レジストリに格納される前に Unicode に変換されます。

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winreg.h (Windows.h を含む)
Library	Advapi32.lib
[DLL]	Advapi32.dll