Fungsi JetGetObjectInfo

Berlaku untuk: Windows | Windows Server

Fungsi JetGetObjectInfo

Fungsi JetGetObjectInfo mengambil informasi tentang objek database. Saat ini, hanya tabel yang didukung. JetGetTableInfo dapat digunakan untuk mengambil lebih banyak informasi daripada JetGetObjectInfo.

    JET_ERR JET_API JetGetObjectInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          JET_OBJTYP objtyp,
      __in_opt      const tchar* szContainerName,
      __in_opt      const tchar* szObjectName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

Parameter

sesid

Konteks sesi database yang akan digunakan.

dbid

Database tempat informasi diambil.

objtyp

Objek yang berisi informasi yang akan diambil. Saat ini, hanya JET_objtypNil dan JET_objtypTable yang didukung, yang keduanya bersifat identik. Hanya tabel yang akan diambil.

szContainerName

Parameter ini disediakan untuk penggunaan di masa mendatang dan melewati NULL. Nama jenis objek yang akan diambil informasinya.

szObjectName

Nama objek yang berisi informasi yang akan diambil. Saat InfoLevel menggunakan opsi JET_ObjInfoList atau JET_ObjInfoListNoStats untuk mengambil daftar semua objek, nilai ini harus NULL atau string kosong.

Hanya nama tabel yang saat ini didukung.

pvResult

Penunjuk ke buffer yang menerima informasi yang ditentukan.

Ukuran buffer, dalam byte, diteruskan dalam cbMax. Jika gagal, konten pvResult tidak terdefinisi.

Informasi yang disimpan di pvResult bergantung pada InfoLevel.

cbMax

Ukuran, dalam byte, dari buffer yang diteruskan di pvResult.

InfoLevel

Menentukan tipe informasi mana yang akan diambil untuk objek yang ditentukan. Ini mempengaruhi bagaimana pvResult ditafsirkan.

Opsi berikut tersedia untuk diatur untuk parameter ini.

Nilai	Makna
JET_ObjInfo	pvResult ditafsirkan sebagai struktur JET_OBJECTINFO . Struktur JET_OBJECTINFO diisi dengan informasi yang berkaitan dengan objek yang dinamai dalam szObjectName. Jika pemanggil tidak ingin mengetahui jumlah rekaman dan halaman untuk objek, pertimbangkan untuk menggunakan tingkat informasi JET_ObjInfoNoStats, yang mungkin lebih cepat karena statistik tidak disertakan.
JET_ObjInfoList	pvResult ditafsirkan sebagai struktur JET_OBJECTLIST . Informasi tentang semua objek diambil. Tabel sementara akan dibuat, dan informasi yang diperlukan untuk melintasi tabel sementara dijelaskan dalam struktur JET_OBJECTLIST . Untuk informasi selengkapnya, lihat JET_OBJECTLIST. Jika penelepon tidak ingin mengetahui jumlah rekaman dan halaman untuk objek, pertimbangkan untuk menggunakan JET_ObjInfoListNoStats, yang mungkin lebih cepat.
JET_ObjInfoListACM	Tidak digunakan lagi dan saat ini tidak didukung.
JET_ObjInfoListNoStats	pvResult ditafsirkan sebagai struktur JET_OBJECTLIST . Informasi tentang semua objek diambil. Tabel sementara akan dibuat, dan informasi yang diperlukan untuk melintasi tabel sementara dijelaskan dalam struktur JET_OBJECTLIST . Untuk informasi selengkapnya, lihat JET_OBJECTLIST. JET_ObjInfoListNoStats identik dengan JET_ObjInfoList, kecuali bahwa kolom yang melaporkan jumlah rekaman (columnidcRecord) dan halaman (columnidcPage) tidak akan diperbarui.
JET_ObjInfoMax	pvResult ditafsirkan sebagai JET_OBJECTINFO. Ukuran maksimum objek ada di halaman. Saat ini hanya tabel yang akan dikembalikan.
JET_ObjInfoNoStats	pvResult ditafsirkan sebagai JET_OBJECTINFO. Informasi tentang hanya objek yang diberikan dalam szObjectName yang akan diambil. Struktur JET_OBJECTINFO akan diisi dengan informasi yang berkaitan dengan objek yang dinamai dalam szObjectName. JET_ObjInfoNoStats identik dengan JET_ObjInfo, kecuali bahwa bidang yang melaporkan jumlah rekaman dan halaman diatur ke nol.
JET_ObjInfoRulesLoaded	Tidak digunakan lagi dan saat ini tidak didukung.
JET_ObjInfoSysTabCursor	Tidak digunakan lagi dan saat ini tidak didukung.
JET_ObjInfoSysTabReadOnly	Tidak digunakan lagi dan saat ini tidak didukung.

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_errBufferTooSmall	Ukuran buffer yang diberikan dalam cbMax terlalu kecil untuk menyimpan informasi yang diinginkan.
JET_errInvalidName	Nama yang tidak valid diberikan dalam szObjectName atau szContainerName.
JET_errInvalidParameter	Parameter buruk diberikan. Ada kemungkinan bahwa tingkat yang buruk diteruskan ke InfoLevel.

Keterangan

Jika JetGetObjectInfo berhasil membuat tabel sementara (misalnya, JET_ObjInfoList atau JET_ObjInfoNoStats), pemanggil bertanggung jawab untuk menutup tabel sementara dengan JetCloseTable.

JetGetObjectInfo saat ini hanya mendukung pengambilan informasi tentang tabel.

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 JetGetObjectInfoW (Unicode) dan JetGetObjectInfoA (ANSI).

Lihat juga

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo