Fungsi JetGetTableColumnInfo

Artikel
06/13/2023

Berlaku untuk: Windows | Windows Server

Fungsi JetGetTableColumnInfo

Fungsi JetGetTableColumnInfo mengambil informasi tentang kolom tabel.

JET_ERR JET_API JetGetTableColumnInfo(
  __in          JET_SESID sesid,
  __in          JET_TABLEID tableid,
  __in          const tchar* szColumnName,
  __out         void* pvResult,
  __in          unsigned long cbMax,
  __in          unsigned long InfoLevel
);

Parameter

sesid

Konteks sesi database yang akan digunakan untuk panggilan API.

tableid

Tabel yang berisi kolom untuk mengambil informasi.

szColumnName

Nama kolom yang akan diambil informasinya.

pvResult

Penunjuk ke buffer yang akan menerima informasi. Jenis buffer bergantung pada InfoLevel. Pemanggil harus dikonfigurasi untuk menyelaraskan buffer dengan tepat.

cbMax

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

InfoLevel

Jenis informasi yang akan diambil untuk kolom yang ditentukan oleh szColumnName. Format data yang disimpan di pvResult bergantung pada InfoLevel. Untuk skema tabel sementara, lihat JET_COLUMNLIST.

JET_ColInfoListSortColumnid akan mengurutkan tabel sementara menurut columnid.
JET_ColInfoListCompact akan memampatkan output. Untuk informasi selengkapnya tentang output ringkas, lihat JET_COLUMNLIST.

Opsi berikut dapat diatur untuk parameter ini:

Nilai	Makna
JET_ColInfo	pvResult ditafsirkan sebagai JET_COLUMNDEF, dan bidang struktur JET_COLUMNDEF diisi dengan tepat. JET_ColInfo dan JET_ColInfoByColid keduanya mengambil informasi yang sama.
JET_ColInfoBase	pvResult ditafsirkan sebagai struktur JET_COLUMNBASE . Ini mirip dengan struktur JET_COLUMNDEF . Jika fungsi ini berhasil, struktur diisi dengan nilai yang sesuai. Jika fungsi ini gagal, struktur berisi data yang tidak terdefinisi.
JET_ColInfoByColid	pvResult ditafsirkan sebagai JET_COLUMNDEF, kecuali InfoLevel ini menunjukkan bahwa kolom yang diminta (szColumName) bukan nama kolom string, tetapi penunjuk ke JET_COLUMNID. JET_ColInfo dan JET_ColInfoByColid keduanya mengambil informasi yang sama.
JET_ColInfoList	pvResult ditafsirkan sebagai struktur JET_COLUMNLIST . Jika fungsi ini berhasil, struktur diisi dengan nilai yang sesuai. Tabel sementara dibuka dan diidentifikasi oleh anggota tableid JET_COLUMNLIST. Tabel harus ditutup dengan JetCloseTable. Jika fungsi ini gagal, struktur berisi data yang tidak terdefinisi.
JET_ColInfoListCompact	pvResult ditafsirkan sebagai struktur JET_COLUMNLIST . Jika fungsi ini berhasil, struktur diisi dengan nilai yang sesuai. Tabel sementara dibuka dan diidentifikasi oleh anggota tableid JET_COLUMNLIST. Tabel harus ditutup dengan JetCloseTable. Jika fungsi ini gagal, struktur berisi data yang tidak terdefinisi.
JET_ColInfoListSortColumnid	Sama seperti JET_ColInfoList, namun tabel yang dihasilkan diurutkan menurut columnid, bukan nama kolom.
JET_ColInfoSysTabCursor	JET_ColInfoSysTabCursor tidak digunakan lagi, dan penggunaannya akan mengembalikan JET_errFeatureNotAvailable.
JET_ColInfoBaseByColId	Sama seperti JET_ColInfoBase, pvResult ditafsirkan sebagai JET_COLUMNBASE, kecuali InfoLevel ini menunjukkan bahwa kolom yang diminta (szColumName) bukan nama kolom string, tetapi penunjuk ke JET_COLUMNID. Windows Vista: Ini tersedia di Windows Vista dan yang lebih baru.
JET_ColInfoGrbitNonDerivedColumnsOnly	Hanya kembalikan kolom yang tidak diturunkan (jika tabel berasal dari templat). Nilai ini dapat secara logis atau masuk ke InfoLevel, ketika InfoLevel dasar JET_ColInfoList. Windows Vista: Nilai ini diperkenalkan di Windows Vista.
JET_ColInfoGrbitMinimalInfo	Hanya mengembalikan nama kolom dan columnid dari setiap kolom. Nilai ini dapat secara logis atau masuk ke InfoLevel, ketika InfoLevel dasar JET_ColInfoList. Windows Vista: Nilai ini diperkenalkan di Windows Vista.
JET_ColInfoGrbitSortByColumnid	Urutkan daftar kolom yang dikembalikan menurut columnid (defaultnya adalah mengurutkan daftar menurut nama kolom). Nilai ini dapat secara logis atau masuk ke InfoLevel, ketika InfoLevel dasar JET_ColInfoList. Windows Vista: Nilai ini diperkenalkan di Windows Vista.

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_errColumnNotFound	Kolom bernama szColumnName tidak ditemukan dalam tabel.
JET_errFeatureNotAvailable	InfoLevel yang buruk ditentukan.
JET_errInvalidName	Kesalahan ini dapat dikembalikan jika: Nama yang buruk untuk szTableName diberikan. Nama yang buruk untuk szColumnName diberikan.
JET_errInvalidParameter	Kesalahan ini dapat dikembalikan jika: InfoLevel yang buruk ditentukan. SzTableName NULL diteruskan. Buffer terlalu kecil.

Keterangan

JetGetTableColumnInfo dan JetGetColumnInfo mengambil informasi tentang kolom. Perbedaan di antara mereka adalah bagaimana tabel diidentifikasi:

JetGetTableColumnInfo mengidentifikasi tabel menurut tableid.
JetGetColumnInfo mengidentifikasi tabel dengan kombinasi dbid dan szTableName .

Saat mengambil data dengan JET_ColInfoList, JET_ColInfoListSortColumnid, atau JET_ColInfoListCompact, tabel sementara akan dibuka. Tabel sementara berisi data, dan struktur JET_COLUMNLIST berisi informasi yang memadai untuk melintasi tabel sementara. Tabel sementara harus ditutup dengan JetCloseTable.

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 JetGetTableColumnInfoW (Unicode) dan JetGetTableColumnInfoA (ANSI).

Lihat juga

Kesalahan Mesin Penyimpanan yang Dapat Diperluas
Parameter Penanganan Kesalahan
JET_COLUMNBASE
JET_COLUMNDEF
JET_COLUMNID
JET_COLUMNLIST
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCloseTable
JetGetColumnInfo
JetGetTableColumnInfo

Fungsi JetGetTableColumnInfo