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

sesid

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 diselaraskan untuk menahan jenis yang diperlukan. Jenis buffer tergantung pada parameter InfoLevel .

cbResult

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

InfoLevel

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

Nilai	Makna
JET_IdxInfo	pvResult ditafsirkan sebagai struktur JET_INDEXLIST . Jika berhasil, struktur JET_INDEXLIST menerima informasi tentang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoCount	pvResult ditafsirkan sebagai ULONG. Jika berhasil, ULONG menyimpan hitungan indeks pada tabel yang ditentukan. szIndexName diabaikan. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoIndexId	pvResult ditafsirkan sebagai JET_INDEXID. Jika 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 di Windows XP.
JET_IdxInfoList	pvResult ditafsirkan sebagai struktur JET_INDEXLIST . Jika 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. Jika berhasil, ULONG memegang penggunaan ruang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.
JET_IdxInfoSysTabCursor	JET_IdxInfoSysTabCursor sudah usang.
JET_IdxInfoVarSegMac	pvResult ditafsirkan sebagai USHORT. Setelah berhasil, USHORT memegang 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. Jika berhasil, USHORT memegang nilai cbKeyMost yang digunakan saat indeks dibuat. Lihat JET_INDEXCREATE untuk deskripsi cbKeyMost. Jika gagal, konten pvBuffer tidak terdefinisi. Windows Vista: JET_IdxInfoKeyMost diperkenalkan di Windows Vista.
JET_IdxInfoCreateIndex	pvResult ditafsirkan sebagai struktur JET_INDEXCREATE . Jika gagal, konten pvBuffer tidak terdefinisi. Windows 7: JET_IdxInfoCreateIndex diperkenalkan di Windows 7.
JET_IdxInfoCreateIndex2	pvResult ditafsirkan sebagai struktur JET_INDEXCREATE2 . Jika gagal, konten pvBuffer tidak terdefinisi. Windows 7: JET_IdxInfoCreateIndex2 diperkenalkan di Windows 7.

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_errIndexNotFound	Indeks yang ditentukan tidak dapat ditemukan dalam tabel yang ditentukan.
JET_wrnBufferTruncated	Buffer yang diteruskan sebagai pvResult terlalu kecil. Isi buffer tidak terdefinisi.

Keterangan

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).

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 JetGetIndexInfoW (Unicode) dan JetGetIndexInfoA (ANSI).

Lihat juga

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_INDEXCREATE
JET_INDEXID
JET_SESID
JET_TABLEID
JetGetTableIndexInfo