RegRenameKey 関数 (winreg.h)
指定したレジストリ キーの名前を変更します。
構文
LSTATUS RegRenameKey(
HKEY hKey,
LPCWSTR lpSubKeyName,
LPCWSTR lpNewKeyName
);
パラメーター
hKey
名前を変更するキーへのハンドル。 ハンドルは、KEY_WRITEアクセス権で開く必要があります。 詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
このハンドルは、 RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。または、次の 定義済みキーのいずれかになります。
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_USERS
lpSubKeyName
名前を変更するサブキーの名前。 このキーは、 hKey パラメーターで識別されるキーのサブキーである必要があります。 このパラメーターは NULL にすることもできます。この場合、 hKey パラメーターで識別されるキーの名前が変更されます。
lpNewKeyName
キーの新しい名前。 新しい名前が存在してはいけません。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラー コードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。 STATUS_ACCESS_DENIEDのエラー コードは、呼び出し元に、指定されたレジストリ キーまたはサブキーに対する必要なアクセス権がないことを示します。
注釈
この関数を使用して、レジストリ サブツリー全体の名前を変更できます。 呼び出し元は、指定したキーの親へのKEY_CREATE_SUB_KEYアクセス権と、名前を変更するサブツリー全体への DELETE アクセス権を持っている必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| Header | winreg.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |