RegSetValueA 関数 (winreg.h)
指定したレジストリ キーの既定値または名前のない値のデータを設定します。 データはテキスト文字列である必要があります。
構文
LSTATUS RegSetValueA(
[in] HKEY hKey,
[in, optional] LPCSTR lpSubKey,
[in] DWORD dwType,
[in] LPCSTR lpData,
[in] DWORD cbData
);
パラメーター
[in] hKey
開いているレジストリ キーへのハンドル。 キーは、KEY_SET_VALUEアクセス権で開かれている必要があります。 詳細については、「レジストリ キーのセキュリティとアクセス権のを
このハンドルは、
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_USERS
[in, optional] lpSubKey
hKey パラメーターのサブキーの名前。 この関数は、指定したサブキーの既定値を設定します。 lpSubKey
キー名では大文字と小文字は区別されません。
このパラメーターが NULL
詳細については、「レジストリ要素のサイズ制限
[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 を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | winreg.h (Windows.h を含む) |
| ライブラリ | Advapi32.lib |
| DLL | Advapi32.dll |
関連項目
RegCreateKeyEx の
RegOpenKeyEx を
RegQueryValueEx の
RegSetValueEx を
レジストリ関数 を