Fungsi JetGetAttachInfoInstance

Berlaku untuk: Windows | Windows Server

Fungsi JetGetAttachInfoInstance

Fungsi JetGetAttachInfoInstance digunakan selama pencadangan yang dimulai oleh JetBeginExternalBackupInstance untuk mengkueri instans nama file database yang harus menjadi bagian dari kumpulan file cadangan. Hanya database yang saat ini dilampirkan ke instans menggunakan JetAttachDatabase yang akan dipertimbangkan. File-file ini kemudian dapat dibuka menggunakan JetOpenFileInstance dan dibaca menggunakan JetReadFileInstance.

Windows XP: JetGetAttachInfoInstance diperkenalkan di Windows XP.

    JET_ERR JET_API JetGetAttachInfoInstance(
      __in          JET_INSTANCE instance,
      __out_opt     tchar* szz,
      __in          unsigned long cbMax,
      __out_opt     unsigned long* pcbActual
    );

Parameter

Sebagai contoh

Instans yang digunakan untuk panggilan ini.

Untuk Windows 2000, varian API yang menerima parameter ini tidak tersedia karena hanya satu instans yang didukung. Penggunaan instans global yang satu ini tersirat dalam kasus ini.

Untuk rilis Windows XP dan yang lebih baru, varian API yang tidak menerima parameter ini hanya dapat dipanggil ketika mesin berada dalam mode warisan (mode kompatibilitas Windows 2000) di mana hanya satu instans yang didukung. Jika tidak, operasi akan gagal dengan JET_errRunningInMultiInstanceMode.

szz

Buffer output yang menerima daftar string null yang dihentikan yang menjelaskan kumpulan file database yang harus menjadi bagian dari kumpulan file cadangan. Daftar string yang dikembalikan dalam buffer ini dalam format yang sama dengan multi-string yang digunakan oleh registri. Setiap string yang dihentikan null dikembalikan secara berurutan diikuti dengan terminator null akhir.

cbMax

Ukuran maksimum dalam byte dari buffer output.

pcbActual

Penunjuk ke buffer output yang menerima jumlah data string aktual.

Tampilkan Nilai

Fungsi ini mengembalikan jenis data JET_ERR dengan salah satu kode pengembalian berikut. Untuk informasi selengkapnya tentang kemungkinan kesalahan ESE, lihat Kesalahan Mesin Penyimpanan yang Dapat Diperluas dan Parameter Penanganan Kesalahan.

Menampilkan kode	Deskripsi
JET_errSuccess	Operasi berhasil diselesaikan.
JET_errBackupAbortByServer	Operasi gagal karena cadangan eksternal saat ini telah dibatalkan oleh panggilan ke JetStopBackupInstance. Kesalahan ini hanya akan dikembalikan oleh Windows XP dan rilis yang lebih baru.
JET_errClientRequestToStopJetService	Tidak dimungkinkan untuk menyelesaikan operasi karena semua aktivitas pada instans yang terkait dengan sesi telah berhenti sebagai akibat dari panggilan ke JetStopServiceInstance.
JET_errInstanceUnavailable	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi telah mengalami kesalahan fatal yang mengharuskan akses ke semua data dicabut untuk melindungi integritas data tersebut. Kesalahan ini hanya akan dikembalikan oleh Windows XP dan rilis yang lebih baru.
JET_errInvalidBackupSequence	Operasi pencadangan gagal karena dipanggil keluar dari urutan. JetGetAttachInfoInstance akan mengembalikan kesalahan ini jika cadangan saat ini bukan pencadangan penuh.
JET_errInvalidParameter	Salah satu parameter yang disediakan berisi nilai yang tidak terduga atau berisi nilai yang tidak masuk akal ketika dikombinasikan dengan nilai parameter lain. Ini dapat terjadi untuk JetGetAttachInfoInstance ketika handel instans yang ditentukan tidak valid (Windows XP dan rilis yang lebih baru).
JET_errNoBackup	Operasi gagal karena tidak ada pencadangan eksternal yang sedang berlangsung.
JET_errNotInitialized	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi belum diinisialisasi.
JET_errRestoreInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena operasi pemulihan sedang berlangsung pada instans yang terkait dengan sesi.
JET_errRunningInMultiInstanceMode	Operasi gagal karena upaya dilakukan untuk menggunakan mesin dalam mode warisan (mode kompatibilitas Windows 2000) di mana hanya satu instans yang didukung ketika sebenarnya beberapa instans sudah ada.
JET_errTermInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi sedang dimatikan.

Jika berhasil, informasi yang diminta pada kumpulan file database yang harus menjadi bagian dari kumpulan file cadangan akan ditempatkan di buffer output jika disediakan.

Jika gagal, status buffer output tidak terdefinisi. Kegagalan akan mengakibatkan pembatalan seluruh proses pencadangan untuk instans.

Keterangan

Penting untuk dicatat bahwa API ini tidak mengembalikan kesalahan atau peringatan jika buffer output terlalu kecil untuk menerima daftar lengkap file yang harus menjadi bagian dari kumpulan file cadangan. Aplikasi harus selalu menyediakan buffer untuk menerima ukuran aktual daftar ini dan menggunakan informasi tersebut untuk menentukan apakah daftar terpotok.

Persyaratan

Persyaratan	Nilai
Klien	Memerlukan Windows Vista atau Windows XP.
Server	Memerlukan Windows Server 2008 atau Windows Server 2003.
Header	Dinyatakan dalam Esent.h.
Pustaka	Gunakan ESENT.lib.
DLL	Membutuhkan ESENT.dll.
Unicode	Diimplementasikan sebagai JetGetAttachInfoInstanceW (Unicode) dan JetGetAttachInfoInstanceA (ANSI).

Lihat juga

JET_ERR
JET_INSTANCE
JetAttachDatabase
JetBeginExternalBackupInstance
JetOpenFileInstance
JetReadFileInstance
JetStopBackupInstance
JetStopServiceInstance