RegCopyTreeA 関数 (winreg.h)

  • [アーティクル]

指定したレジストリ キーとその値とサブキーを、指定したコピー先キーにコピーします。

構文

LSTATUS RegCopyTreeA(
  [in]           HKEY   hKeySrc,
  [in, optional] LPCSTR lpSubKey,
  [in]           HKEY   hKeyDest
);

パラメーター

[in] hKeySrc

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

このハンドルは、 RegCreateKeyEx または RegOpenKeyEx 関数によって返されるか、 定義済みのキーのいずれかになります。

[in, optional] lpSubKey

キーの名前です。 このキーは、 hKeySrc パラメーターによって識別されるキーのサブキーである必要があります。 このパラメーターには NULL を指定することもできます。

[in] hKeyDest

宛先キーのハンドル。 呼び出し元のプロセスには、キーへのKEY_CREATE_SUB_KEYアクセス権が必要です。

このハンドルは、 RegCreateKeyEx または RegOpenKeyEx 関数によって返されるか、 定義済みのキーのいずれかになります。

戻り値

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

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

注釈

この関数は、キーのセキュリティ記述子もコピーします。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを 0x0600 以降として定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。

注意

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

要件

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

こちらもご覧ください

レジストリ関数