Fungsi JetGetIndexInfo

Berlaku untuk: Windows | Windows Server

Fungsi JetGetIndexInfo

Fungsi JetGetIndexInfo mengambil informasi tentang indeks.

    JET_ERR JET_API JetGetIndexInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          const tchar* szTableName,
      __in          const tchar* szIndexName,
      __out         void* pvResult,
      __in          unsigned long cbResult,
      __in          unsigned long InfoLevel
    );

Parameter-parameternya

di-sesi

Konteks sesi database yang akan digunakan untuk panggilan API.

dbid

Pengidentifikasi database yang digunakan untuk panggilan API.

szTableName

Nama tabel yang berisi indeks dengan informasi yang akan diambil.

szIndexName

Nama indeks dengan informasi yang akan diambil.

pvResult

Penunjuk ke buffer yang akan menerima informasi yang diinginkan. Buffer harus diratakan untuk menahan jenis yang diperlukan. Jenis buffer bergantung pada parameter InfoLevel .

cbResult

Ukurannya, dalam byte, dari buffer yang diteruskan sebagai pvResult.

InfoLevel

Informasi yang akan disimpan di pvResult. Opsi berikut dapat digunakan untuk parameter ini.

Nilai	Meaning
JET_IdxInfo	pvResult ditafsirkan sebagai struktur JET_INDEXLIST . Setelah berhasil, struktur JET_INDEXLIST menerima informasi tentang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoCount	pvResult ditafsirkan sebagai ULONG. Jika berhasil, ULONG menyimpan jumlah indeks pada tabel yang ditentukan. szIndexName diabaikan. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoIndexId	pvResult ditafsirkan sebagai JET_INDEXID. Setelah berhasil, struktur JET_INDEXID menerima informasi tentang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoLangid	JET_IdxInfoLangid tidak digunakan lagi. Gunakan JET_IdxInfoLCID dan makro LANGIDFROMLCID sebagai gantinya.
JET_IdxInfoLCID	pvResult ditafsirkan sebagai LCID. Setelah berhasil, LCID memegang Pengidentifikasi Lokal indeks. Jika gagal, konten pvBuffer tidak terdefinisi. Windows XP: JET_IdxInfoLCID diperkenalkan dalam Windows XP.
JET_IdxInfoList	pvResult ditafsirkan sebagai struktur JET_INDEXLIST . Setelah berhasil, struktur JET_INDEXLIST menerima informasi tentang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoOLC	JET_IdxInfoOLC sudah usang.
JET_IdxInfoResetOLC	JET_IdxInfoResetOLC sudah usang.
JET_IdxInfoSpaceAlloc	pvResult ditafsirkan sebagai ULONG. Pada keberhasilan, ULONG memegang kepadatan target (ulDensitas) indeks. Lihat JET_INDEXCREATE untuk deskripsi ulDensity. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoSysTabCursor	JET_IdxInfoSysTabCursor sudah usang.
JET_IdxInfoVarSegMac	pvResult ditafsirkan sebagai USHORT. Setelah berhasil, USHORT menyimpan nilai cbVarSegMac yang digunakan saat indeks dibuat. Lihat JET_INDEXCREATE untuk deskripsi cbVarSegMac. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoKeyMost	pvResult ditafsirkan sebagai USHORT. Setelah berhasil, USHORT menyimpan nilai cbKeyMost yang digunakan saat indeks dibuat. Lihat JET_INDEXCREATE untuk deskripsi cbKeyMost. Jika gagal, konten pvBuffer tidak terdefinisi. Windows Vista: JET_IdxInfoKeyMost diperkenalkan dalam Windows Vista.
JET_IdxInfoCreateIndex	pvResult ditafsirkan sebagai struktur JET_INDEXCREATE . Jika gagal, konten pvBuffer tidak terdefinisi. Windows 7: JET_IdxInfoCreateIndex diperkenalkan dalam Windows 7.
JET_IdxInfoCreateIndex2	pvResult ditafsirkan sebagai struktur JET_INDEXCREATE2 . Jika gagal, konten pvBuffer tidak terdefinisi. Windows 7: JET_IdxInfoCreateIndex2 diperkenalkan dalam Windows 7.
JET_IdxInfoSpaceOwned	pvResult ditafsirkan sebagai ULONG. Pada keberhasilan, ULONG menyimpan jumlah halaman yang dimiliki oleh indeks. Lihat Keterangan untuk informasi selengkapnya. Windows 11:JET_IdxInfoSpaceOwned diperkenalkan dalam Windows 11.
JET_IdxInfoSpaceAvail	pvResult ditafsirkan sebagai ULONG. Jika berhasil, ULONG menahan jumlah halaman yang tersedia dalam indeks. Lihat Keterangan untuk informasi selengkapnya. Windows 11:JET_IdxInfoSpaceAvail diperkenalkan dalam Windows 11.

Mengembalikan Nilai

Fungsi ini mengembalikan tipe 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.

Mengembalikan kode	Description
JET_errSuccess	Operasi berhasil diselesaikan.
JET_errIndexNotFound	Indeks yang ditentukan tidak dapat ditemukan dalam tabel yang ditentukan.
JET_wrnBufferTruncated	Buffer diteruskan karena pvResult terlalu kecil. Isi buffer tidak terdefinisi.

Komentar

JetGetIndexInfo dan JetGetTableIndexInfo mengambil informasi yang identik tentang indeks. Perbedaannya adalah bagaimana tabel ditentukan. JetGetIndexInfo mengharapkan database (dbid) dan nama tabel (szTableName), sementara JetGetTableIndexInfo mengharapkan pengidentifikasi tabel (tableid).

Ruang yang digunakan oleh indeks ditentukan oleh $Used + Avail = Owned$. Oleh karena itu untuk mendapatkan jumlah halaman yang digunakan, gunakan rumus $Owned - Avail = Used$ (dapat diambil dengan JET_IdxInfoSpaceOwned dan JET_IdxInfoSpaceAvail).

Persyaratan

Persyaratan	Nilai
Client	Memerlukan Windows Vista, Windows XP, atau Windows 2000 Professional.
Server	Memerlukan server Windows Server 2008, Windows Server 2003, atau Windows 2000.
Header	Dinyatakan dalam Esent.h.
Library	Gunakan ESENT.lib.
DLL	Membutuhkan ESENT.dll.
Unicode	Diimplementasikan sebagai JetGetIndexInfoW (Unicode) dan JetGetIndexInfoA (ANSI).

Lihat Juga

JET_COLUMNIDJET_ERRJET_GRBIT JET_INDEXCREATEJET_INDEXCREATE2 JET_INDEXCREATE JET_INDEXIDJET_INDEXLISTJET_SESIDJET_TABLEIDJetGetTableIndexInfo