Fungsi RegSaveKeyA (winreg.h)

Artikel
11/20/2024

Menyimpan kunci yang ditentukan dan semua subkuntip dan nilainya ke file baru, dalam format standar.

Untuk menentukan format untuk kunci atau sarang yang disimpan, gunakan fungsi RegSaveKeyEx.

Aplikasi yang mencadangkan atau memulihkan status sistem termasuk file sistem dan sarang registri harus menggunakan Volume Shadow Copy Service alih-alih fungsi registri.

Sintaksis

LSTATUS RegSaveKeyA(
  [in]           HKEY                        hKey,
  [in]           LPCSTR                      lpFile,
  [in, optional] const LPSECURITY_ATTRIBUTES lpSecurityAttributes
);

Parameter

[in] hKey

Handel ke kunci registri terbuka.

Handel ini dikembalikan oleh fungsi RegCreateKeyEx atau Fungsi RegOpenKeyEx, atau dapat menjadi salah satu kunci berikut yang telah ditentukan sebelumnya:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

[in] lpFile

Nama file tempat kunci dan subkey yang ditentukan akan disimpan. Jika file sudah ada, fungsi gagal.

Jika string tidak menyertakan jalur, file dibuat di direktori saat ini dari proses panggilan untuk kunci lokal, atau di direktori %systemroot%\system32 untuk kunci jarak jauh. File baru memiliki atribut arsip.

[in, optional] lpSecurityAttributes

Penunjuk ke struktur SECURITY_ATTRIBUTES yang menentukan deskriptor keamanan untuk file baru. Jika lpSecurityAttributesNULL, file akan mendapatkan pendeskripsi keamanan default. ACL dalam deskriptor keamanan default untuk file diwarisi dari direktori induknya.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah ERROR_SUCCESS.

Jika fungsi gagal, nilai pengembalian adalah kode kesalahan nonzero yang ditentukan dalam Winerror.h. Anda dapat menggunakan fungsi FormatMessage dengan bendera FORMAT_MESSAGE_FROM_SYSTEM untuk mendapatkan deskripsi umum tentang kesalahan tersebut.

Jika file sudah ada, fungsi gagal dengan kesalahan ERROR_ALREADY_EXISTS.

Komentar

Jika hKey mewakili kunci pada komputer jarak jauh, jalur yang dijelaskan oleh lpFile relatif terhadap komputer jarak jauh.

Fungsi RegSaveKey hanya menyimpan kunci nonvolatile. Ini tidak menyimpan kunci volatil. Kunci dibuat volatil atau nonvolatile pada pembuatannya; lihat RegCreateKeyEx.

Anda dapat menggunakan file yang dibuat oleh RegSaveKey dalam panggilan berikutnya ke fungsi RegLoadKey, RegReplaceKey, atau RegRestoreKey. Jika RegSaveKey gagal melalui operasinya, file akan rusak dan panggilan berikutnya ke RegLoadKey, RegReplaceKey, atau RegRestoreKey untuk file akan gagal.

Menggunakan RegSaveKey bersama dengan RegRestoreKey untuk menyalin subtree di registri tidak disarankan. Metode ini tidak memicu pemberitahuan dan dapat membatalkan handel yang digunakan oleh aplikasi lain. Sebagai gantinya, gunakan fungsi SHCopyKey atau fungsi RegCopyTree.

Proses panggilan harus mengaktifkan hak istimewa SE_BACKUP_NAME. Untuk informasi selengkapnya, lihat Berjalan dengan Hak Istimewa Khusus.

Nota

Header winreg.h mendefinisikan RegSaveKey sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	winreg.h (termasuk Windows.h)
Pustaka	Advapi32.lib
DLL	Advapi32.dll