Fungsi JetRenameColumn

Artikel
06/13/2023

Berlaku untuk: Windows | Windows Server

Fungsi JetRenameColumn

Fungsi JetRenameColumn dapat digunakan untuk mengubah nama kolom yang ada pada tabel.

Windows XP:JetRenameColumn diperkenalkan di Windows XP.

    JET_ERR JET_API JetRenameColumn(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_PCSTR szName,
      __in          JET_PCSTR szNameNew,
      __in          JET_GRBIT grbit
    );

Parameter

sesid

Sesi yang digunakan untuk panggilan ini.

tableid

Kursor yang digunakan untuk panggilan ini.

szName

Nama kolom saat ini yang akan diganti namanya.

szNameNew

Nama baru untuk kolom yang akan diganti namanya.

grbit

Parameter ini harus berupa 0.

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_errClientRequestToStopJetService	Tidak mungkin untuk menyelesaikan operasi karena semua aktivitas pada instans yang terkait dengan sesi telah berhenti sebagai akibat dari panggilan ke JetStopService.
JET_errColumnNotFound	Kolom yang ditentukan ini tidak ada untuk tabel ini.
JET_errInvalidName	Salah satu nama objek yang ditentukan tidak valid. Semua nama objek harus sesuai dengan sekumpulan aturan yang sama. Aturan ini adalah sebagai berikut: Nama objek harus terdiri dari karakter ASCII. Panjang nama objek harus minimal satu karakter. Panjang nama objek tidak boleh melebihi JET_cbNameMost (64). Nama objek mungkin tidak dimulai dengan spasi - nama objek mungkin tidak berisi karakter kontrol ASCII (0x00 melalui 0x1F). Nama objek tidak boleh berisi karakter tanda seru (!), titik (.), kurung kiri ([), atau tanda kurung kanan (]). Setelah divalidasi, hanya bagian string hingga spasi pertama (jika ada) yang akan digunakan untuk nama objek. Ini secara efektif berarti bahwa nama objek mungkin juga tidak berisi spasi.
JET_errInvalidParameter	Salah satu parameter yang disediakan berisi nilai yang tidak terduga atau berisi nilai yang tidak masuk akal ketika dikombinasikan dengan nilai parameter lain. Ini dapat terjadi untuk JetRenameColumn ketika: szName adalah NULL. szNameNew adalah NULL.
JET_errInstanceUnavailable	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi telah mengalami kesalahan fatal yang mengharuskan akses ke semua data dicabut untuk melindungi integritas data tersebut. Kesalahan ini hanya akan dikembalikan oleh Windows XP dan rilis yang lebih baru.
JET_errInTransaction	Operasi ini hanya dapat dilakukan ketika sesi saat ini tidak berada di dalam transaksi.
JET_errNotInitialized	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi belum diinisialisasi.
JET_errRestoreInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena operasi pemulihan sedang berlangsung pada instans yang terkait dengan sesi.
JET_errSessionSharingViolation	Sesi yang sama tidak dapat digunakan untuk lebih dari satu utas secara bersamaan. Kesalahan ini hanya akan dikembalikan oleh Windows XP dan rilis yang lebih baru.
JET_errTermInProgress	Tidak dimungkinkan untuk menyelesaikan operasi karena instans yang terkait dengan sesi sedang dimatikan.
JET_errTransReadOnly	Pembaruan tidak dapat dilakukan saat berada di dalam cakupan transaksi baca-saja. Transaksi baca-saja adalah transaksi yang telah dimulai menggunakan panggilan ke JetBeginTransaction2 dengan JET_bitTransactionReadOnly. Kesalahan ini hanya akan dikembalikan oleh Windows XP dan rilis yang lebih baru.

Jika berhasil, nama kolom yang ditentukan dalam tabel yang terkait dengan kursor diubah secara permanen ke nama baru. Indeks apa pun yang mereferensikan kolom tersebut juga akan diperbarui.

Jika gagal, tidak ada perubahan pada status database yang akan terjadi.

Keterangan

Operasi penggantian nama kolom tidak biasa karena, tidak seperti operasi skema lainnya, itu tidak dilakukan sebagai transaksi. Saat kolom dalam tabel tertentu diganti namanya dalam satu sesi, sesi lain yang menggunakan tabel tersebut akan segera melihat perubahan, bahkan jika mereka berada dalam transaksi yang akan mencegah sesi tersebut melihat perubahan lain yang dilakukan oleh sesi yang melakukan operasi penggantian nama.

ID kolom kolom tidak terpengaruh oleh operasi ganti nama.

Persyaratan

Persyaratan	Nilai
Klien	Memerlukan Windows Vista atau Windows XP.
Server	Memerlukan Windows Server 2008 atau Windows Server 2003.
Header	Dinyatakan dalam Esent.h.
Pustaka	Gunakan ESENT.lib.
DLL	Membutuhkan ESENT.dll.
Unicode	Diimplementasikan sebagai JetRenameColumnW (Unicode) dan JetRenameColumnA (ANSI).

Lihat juga

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetBeginTransaction2

Fungsi JetRenameColumn