Fungsi JetSetLS

Berlaku untuk: Windows | Windows Server

Fungsi JetSetLS

Fungsi JetSetLS memungkinkan aplikasi untuk mengaitkan handel konteks yang dikenal sebagai Penyimpanan Lokal dengan kursor atau tabel yang terkait dengan kursor tersebut. Handel konteks ini dapat digunakan oleh aplikasi untuk menyimpan data tambahan yang terkait dengan kursor atau tabel. Aplikasi kemudian diberi tahu menggunakan panggilan balik runtime ketika handel konteks harus dirilis. Ini memungkinkan untuk mengaitkan status yang dialokasikan secara dinamis dengan kursor atau tabel.

Windows XP:JetSetLS diperkenalkan di Windows XP.

    JET_ERR JET_API JetSetLS(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_LS ls,
      __in          JET_GRBIT grbit
    );

Parameter

sesid

Sesi yang digunakan untuk panggilan ini.

tableid

Kursor yang digunakan untuk panggilan ini.

Ls

Handel konteks yang akan dikaitkan dengan kursor atau tabel.

Ketika JET_bitLSReset ditentukan maka nilai aktual parameter ini diabaikan dan JET_LSNil digunakan.

grbit

Sekelompok bit yang berisi opsi yang akan digunakan untuk panggilan ini, yang mencakup nol atau beberapa hal berikut ini.

Nilai	Makna
JET_bitLSCursor	Opsi ini menunjukkan bahwa handel konteks harus dikaitkan dengan kursor yang diberikan. Jika JET_bitLSCursor atau JET_bitLSTable tidak ditentukan maka JET_bitLSCursor dianggap. Adalah ilegal untuk menggunakan opsi ini dengan JET_bitLSTable. Operasi akan gagal dengan JET_errInvalidgrbit jika ini dicoba.
JET_bitLSReset	Opsi ini menunjukkan bahwa handel konteks yang ditentukan harus diabaikan dan bahwa handel konteks untuk objek yang dipilih harus diatur ulang ke JET_LSNil. Penting untuk dicatat bahwa tindakan ini tidak akan menghasilkan panggilan balik untuk membersihkan nilai sebelumnya dari handel konteks untuk objek yang dipilih. Pembersihan yang tepat dari handel konteks sebelumnya dapat dicapai menggunakan JetGetLS dengan JET_bitLSReset. Lihat JetGetLS untuk informasi selengkapnya.
JET_bitLSTable	Opsi ini menunjukkan bahwa handel konteks harus dikaitkan dengan tabel yang terkait dengan kursor yang diberikan. Adalah ilegal untuk menggunakan opsi ini dengan JET_bitLSCursor. Operasi akan gagal dengan JET_errInvalidgrbit jika ini dicoba.

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_errClientRequestToStopJetService	Tidak mungkin untuk menyelesaikan operasi karena semua aktivitas pada instans yang terkait dengan sesi telah berhenti sebagai akibat dari panggilan ke JetStopService.
JET_errInvalidgrbit	Salah satu opsi yang diminta tidak valid, digunakan dengan tidak benar, atau tidak diimplementasikan. Ini dapat terjadi untuk JetSetLS ketika JET_bitLSCursor dan JET_bitLSTable keduanya ditentukan.
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_errLSAlreadySet	Handel konteks yang diberikan tidak dapat dikaitkan dengan objek yang diminta karena sudah memiliki handel konteks yang terkait dengannya.
JET_errLSCallbackNotSpecified	Handel konteks yang diberikan tidak dapat dikaitkan dengan objek yang diminta karena panggilan balik runtime belum dikonfigurasi untuk instans yang terkait dengan sesi.
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_errTermInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi sedang dimatikan.

Jika berhasil, handel konteks yang diberikan berhasil dikaitkan dengan objek yang diminta. Tidak ada perubahan pada status database yang akan terjadi.

Jika gagal, tidak ada perubahan pada status objek yang diminta telah terjadi. Tidak ada perubahan pada status database yang akan terjadi.

Keterangan

Penyimpanan Lokal untuk kursor atau tabel harus dilihat sebagai cache volatil. Aplikasi harus terlebih dahulu mencoba mengambil handel konteks menggunakan JetGetLS. Jika nilai tidak diatur (yaitu JET_LSNil) maka aplikasi harus membuat konteks baru dan memuatnya ke dalam cache menggunakan JetSetLS. Aplikasi dapat menghapus cache menggunakan panggilan ke JetGetLS dengan JET_bitLSReset. Jika mesin database membersihkan cache, maka panggilan balik runtime akan dihasilkan untuk memberi aplikasi kesempatan untuk membersihkan konteks tersebut. Jenis panggilan balik akan JET_cbtypFreeCursorLS untuk handel konteks yang terkait dengan kursor dan JET_cbtypFreeTableLS untuk handel konteks yang terkait dengan tabel. Dalam kedua kasus, handel konteks akan diteruskan sebagai pvArg1. Lihat JET_CALLBACK untuk informasi selengkapnya.

Panggilan balik runtime harus dikonfigurasi dengan benar untuk instans yang terkait dengan sesi tertentu sebelum Penyimpanan Lokal dapat digunakan. Panggilan balik ini dapat diatur menggunakan JetSetSystemParameter dengan JET_paramRuntimeCallback. Lihat JetSetSystemParameter dan JET_paramRuntimeCallback di Parameter Sistem untuk informasi selengkapnya.

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.

Lihat juga

JET_CALLBACK
JET_ERR
JET_GRBIT
JET_LS
JET_SESID
JET_TABLEID
JetGetLS
JetSetSystemParameter
Parameter Sistem