RegSetKeyValueA 関数 (winreg.h)
指定したレジストリ キーとサブキーの指定した値のデータを設定します。
構文
LSTATUS RegSetKeyValueA(
[in] HKEY hKey,
[in, optional] LPCSTR lpSubKey,
[in, optional] LPCSTR lpValueName,
[in] DWORD dwType,
[in, optional] LPCVOID 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 で識別されるキーを基準としたサブキーの名前。 サブキーが存在しない場合は、既定のセキュリティ記述子を持つ非揮発性キーとして作成されます。 このパラメーターが NULL の場合、 hKey で指定されたキーに値が作成されます。
[in, optional] lpValueName
データを更新するレジストリ値の名前。
[in] dwType
lpData パラメーターによって指されるデータの型。 使用できる型の一覧については、「 レジストリ値の型」を参照してください。
[in, optional] lpData
指定した値名で格納されるデータ。
REG_SZなどの文字列ベースの型の場合、文字列は null で終わる必要があります。 REG_MULTI_SZデータ型では、文字列を 2 つの null 文字で終了する必要があります。
[in] cbData
lpData パラメーターが指す情報のサイズ (バイト単位)。 データの種類がREG_SZ、REG_EXPAND_SZ、またはREG_MULTI_SZの場合、 cbData には終端の null 文字または文字のサイズを含める必要があります。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラー コードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。
注釈
この関数を使用するアプリケーションをコンパイルするには、0x0600 以降として_WIN32_WINNTを定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。
注意
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegSetKeyValue を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winreg.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |