SHRegSetUSValueA 関数 (shlwapi.h)
ユーザー固有のサブツリー (HKEY_CURRENT_USERまたはHKEY_LOCAL_MACHINE) にレジストリ サブキー値を設定します。
構文
LSTATUS SHRegSetUSValueA(
[in] LPCSTR pszSubKey,
[in] LPCSTR pszValue,
[in] DWORD dwType,
[in, optional] const void *pvData,
[in, optional] DWORD cbData,
[in, optional] DWORD dwFlags
);
パラメーター
[in] pszSubKey
型: LPCTSTR
サブキーの名前を持つ null で終わる文字列へのポインター。
[in] pszValue
型: LPCTSTR
値の名前を指定する null で終わる文字列へのポインター。
[in] dwType
型: DWORD
格納するデータの種類。 このパラメーターは 、REG_SZ 型である必要があります。 詳細については、「 レジストリ データ型」を参照してください。
[in, optional] pvData
種類: LPVOID*
指定したキーに設定する値を含む null で終わる文字列への Apointer。
[in, optional] cbData
型: DWORD
pvData パラメーターが指す文字列の長さ (バイト単位)。終端の null 文字は含まれません。
[in, optional] dwFlags
型: DWORD
データを書き込む場所を示すフラグ。
SHREGSET_HKCU
空の場合 は、HKEY_CURRENT_USER に書き込みます。
SHREGSET_FORCE_HKCU
HKEY_CURRENT_USERに書き込 みます。
SHREGSET_HKLM
空の場合 は、HKEY_LOCAL_MACHINE に書き込みます。
SHREGSET_FORCE_HKLM
HKEY_LOCAL_MACHINEに書き込 みます。
SHREGSET_DEFAULT
(SHREGSET_FORCE_HKCU SHREGSET_HKLM | ) と同じです。
戻り値
種類: LSTATUS
成功した場合はERROR_SUCCESSを返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラー コードを返します。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用して、エラーの一般的な説明を取得できます。
注釈
この関数は、キーが使用されるたびにキーを開きます。 コードで同じキーに一連の値を設定する必要がある場合は、 SHRegOpenUSKey を使用してキーを 1 回開き、 SHRegWriteUSValue を使用してデータを書き込む方が効率的です。
注意
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHRegSetUSValue を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | shlwapi.h |
Library | Shlwapi.lib |
[DLL] | Shlwapi.dll (バージョン 4.71 以降) |