Fungsi JetGetSystemParameter

Artikel
06/13/2023

Berlaku untuk: Windows | Windows Server

Fungsi JetGetSystemParameter

Fungsi JetGetSystemParameter membaca banyak pengaturan konfigurasi mesin database.

    JET_ERR JET_API JetGetSystemParameter(
      __in          JET_INSTANCE instance,
      __in          JET_SESID sesid,
      __in          unsigned long paramid,
      __in_out_opt  JET_API_PTR* plParam,
      __out_opt     JET_PSTR szParam,
      __in          unsigned long cbMax
    );

Parameter

Sebagai contoh

Instans yang digunakan untuk panggilan ini.

Untuk Windows 2000, parameter ini diabaikan dan harus selalu NULL.

Untuk rilis Windows XP dan yang lebih baru, parameter ini agak kelebihan beban. Jika mesin beroperasi dalam mode warisan (mode kompatibilitas Windows 2000) di mana hanya satu instans yang didukung, parameter ini mungkin NULL atau mungkin berisi instans aktual yang dikembalikan oleh JetInit. Dalam kedua kasus, semua pengaturan parameter sistem dibaca dari satu instans tersebut. Jika mesin beroperasi dalam mode multi-instans, parameter ini mungkin NULL atau pointer ke instans yang dibuat menggunakan JetInit atau JetCreateInstance. Ketika parameter ini NULL , maka pengaturan parameter sistem global (atau default) dibaca. Ketika parameter ini adalah instans, maka pengaturan parameter sistem untuk instans tersebut dibaca.

sesid

Sesi yang digunakan untuk panggilan ini.

Ketika ditentukan, instans yang ditentukan diabaikan dan instans yang terkait dengan sesi akan digunakan.

paramid

ID parameter sistem yang akan dibaca.

Lihat Parameter Sistem untuk daftar lengkap parameter sistem dan propertinya.

plParam

Buffer output yang menerima nilai parameter sistem yang dipilih jika parameter sistem tersebut adalah jenis bilangan bulat.

szParam

Buffer output yang menerima nilai parameter sistem yang dipilih jika parameter sistem tersebut adalah jenis string.

cbMax

Ukuran maksimum dalam byte dari buffer output string.

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_errInitInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi sedang diinisialisasi.
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_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 JetGetSystemParameter ketika: ID parameter sistem yang ditentukan tidak valid atau tidak didukung. Parameter sistem yang ditentukan mengharuskan buffer output bilangan bulat disediakan dan penunjuk buffer output adalah NULL. Parameter sistem yang ditentukan memerlukan buffer output string untuk disediakan dan penunjuk buffer output adalah NULL. Windows Vista: Ini hanya dapat terjadi pada Windows Vista dan rilis yang lebih baru. Parameter sistem yang ditentukan memerlukan buffer output string yang akan disediakan dan ukuran buffer output tersebut terlalu kecil untuk menerima string null yang dihentikan. Windows Vista: Ini hanya dapat terjadi pada Windows Vista dan rilis yang lebih baru. Parameter sistem yang ditentukan tidak dapat dibaca karena hanya untuk menulis. Parameter sistem yang ditentukan hanya global dan upaya dilakukan untuk membaca nilai spesifik instans untuk parameter sistem tersebut. Ini hanya dapat terjadi pada Windows XP dan rilis yang lebih baru. Parameter sistem yang ditentukan hanya per instans dan upaya dilakukan untuk membaca nilai global untuk parameter sistem tersebut. Ini hanya dapat terjadi pada Windows XP dan rilis yang lebih baru.
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.
JET_errInvalidSesid	Handel sesi tidak valid atau mengacu pada sesi tertutup. Kesalahan ini tidak dikembalikan dalam semua keadaan. Handel hanya divalidasi berdasarkan upaya terbaik.
JET_errInvalidInstance	Handel instans tidak valid atau mengacu pada instans yang telah dimatikan. Kesalahan ini tidak dikembalikan dalam semua keadaan. Handel hanya divalidasi berdasarkan upaya terbaik. Windows Vista: Kesalahan ini hanya akan dikembalikan oleh Windows Vista dan rilis yang lebih baru.
JET_wrnBufferTruncated	Operasi berhasil diselesaikan, tetapi buffer output terlalu kecil untuk menerima seluruh pengaturan parameter sistem. Buffer output telah diisi dengan pengaturan parameter sistem sebanyak yang sesuai. Jika buffer output memiliki panjang setidaknya satu karakter, maka string dalam buffer output tersebut akan dihentikan null. Catatan Kesalahan ini tidak dikembalikan oleh semua rilis. Silakan lihat bagian Keterangan untuk informasi selengkapnya.
JET_errBufferTooSmall	Operasi gagal karena buffer output terlalu kecil untuk menerima seluruh pengaturan parameter sistem. Catatan Kesalahan ini tidak dikembalikan dalam beberapa kasus untuk mempertahankan kompatibilitas aplikasi. Silakan lihat bagian Keterangan untuk informasi selengkapnya. Windows Vista: Kesalahan ini hanya akan dikembalikan oleh Windows Vista dan rilis yang lebih baru.

Jika berhasil, buffer output yang sesuai untuk parameter sistem yang diminta akan diatur ke nilai parameter sistem tersebut.

Jika gagal, status buffer output tidak akan terdefinisi.

Keterangan

Ada masalah penting dalam API ini yang ada di semua rilis. Jika parameter sistem dengan nilai string diminta dan buffer output terlalu kecil untuk menerima seluruh pengaturan parameter sistem, JET_wrnBufferTruncated TIDAK akan dikembalikan. JET_errSuccess dikembalikan sebagai gantinya. Jika panjang string yang dikembalikan sama dengan ukuran buffer output kurang dari terminator NULL , pemanggil harus bereaksi seolah-olah JET_wrnBufferTruncated dikembalikan. Jika buffer output string berukuran nol ditentukan, pemanggil harus bereaksi seolah-olah JET_errInvalidParameter dikembalikan.

Persyaratan

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

Lihat juga

JET_API_PTR
JET_ERR
JET_INSTANCE
JET_SESID
JetCreateInstance
JetInit
JetSetSystemParameter
JetStopService
Parameter Sistem

Bagikan melalui

Fungsi JetGetSystemParameter