Fungsi JetGetTableIndexInfo

Berlaku untuk: Windows | Windows Server

Fungsi JetGetTableIndexInfo

Fungsi JetGetTableIndexInfo mengambil informasi tentang indeks.

    JET_ERR JET_API JetGetTableIndexInfo(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __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.

tableid

Tabel database yang berisi indeks yang menyimpan informasi yang diperlukan.

szIndexName

Nama indeks yang berisi informasi yang akan diambil.

pvResult

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

cbResult

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

InfoLevel

Menentukan informasi mana yang akan disimpan di pvResult. Nilai yang valid adalah:

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_IdxInfoLCID

pvResult ditafsirkan sebagai LCID. Setelah berhasil, LCID memegang Pengidentifikasi Lokal indeks. Jika gagal, konten pvBuffer tidak terdefinisi.

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. Setelah berhasil, ULONG memegang penggunaan ruang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor sudah usang.

JET_IdxInfoLangid

JET_IdxInfoLangid tidak digunakan lagi. Gunakan JET_IdxInfoLCID sebagai gantinya, dan makro LANGIDFROMLCID sebagai gantinya.

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_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_IdxInfoIndexId

pvResult ditafsirkan sebagai JET_INDEXID. Setelah berhasil, struktur JET_INDEXID menerima informasi tentang indeks. Jika gagal, konten pvBuffer tidak terdefinisi.

JET_IdxInfoKeyMost

pvResult ditafsirkan sebagai USHORT. Setelah berhasil, USHORT menyimpan nilai cbKeyMost yang digunakan saat indeks dibuat. Lihat struktur JET_INDEXCREATE untuk deskripsi cbKeyMost. Jika gagal, konten pvBuffer tidak terdefinisi.

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

Deskripsi

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

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 JetGetTableIndexInfoW (Unicode) dan JetGetTableIndexInfoA (ANSI).

Lihat Juga

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID JET_INDEXCREATE2
JET_INDEXLISTJetGetIndexInfo

  • Last updated on