JetRenameTableW

関数

ESENTデータベース内のテーブルの名前を変更する。

DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetRenameTableW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szName,
    WORD* szNameNew
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象テーブルを含むデータベースのID。
szName	WORD*	in	変更前のテーブル名を指すワイド文字列(WORD*)。
szNameNew	WORD*	in	変更後の新しいテーブル名を指すワイド文字列(WORD*)。

戻り値の型: INT

公式ドキュメント

JetRenameTable 関数は、既存のテーブルの名前を変更するために使用できます。

戻り値

この関数は JET_ERR データ型を返し、その値は次のリターンコードのいずれかです。発生し得る ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errClientRequestToStopJetService	JetStopService の呼び出しの結果、セッションに関連付けられたインスタンス上のすべての活動が停止したため、操作を完了できません。
JET_errInstanceUnavailable	セッションに関連付けられたインスタンスで致命的なエラーが発生し、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要があるため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errInvalidDatabase	指定されたデータベースが無効でした。このエラーは、一時データベースに対してテーブルの名前変更操作が試みられた場合に、Windows 2000 でのみ返されます。それ以降のリリースでは、この場合 JET_errInvalidDatabaseId が返されます。
JET_errInvalidDatabaseId	指定されたデータベース ID が無効でした。
JET_errInvalidName	指定されたオブジェクト名のいずれかが無効でした。すべてのオブジェクト名は同一の規則に従う必要があります。規則は次のとおりです。オブジェクト名は ASCII 文字で構成されている必要があります。オブジェクト名は 1 文字以上の長さが必要です。オブジェクト名の長さは JET_cbNameMost (64) 文字を超えることはできません。オブジェクト名をスペースで開始することはできません。オブジェクト名に ASCII 制御文字 (0x00 から 0x1F) を含めることはできません。オブジェクト名に感嘆符 (!)、ピリオド (.)、左角かっこ ([)、右角かっこ (]) の文字を含めることはできません。検証後は、文字列のうち最初のスペース (存在する場合) までの部分のみがオブジェクト名として使用されます。これは事実上、オブジェクト名にスペースを含めることもできないことを意味します。
JET_errInvalidParameter	指定されたパラメーターのいずれかに予期しない値が含まれているか、別のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。JetRenameTable では、次の場合にこれが発生する可能性があります。 szName が NULL である。 szNameNew が NULL である。
JET_errNotInitialized	セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errObjectNotFound	指定されたテーブルは、このデータベースに存在しません。
JET_errRestoreInProgress	セッションに関連付けられたインスタンスで復元操作が進行中のため、操作を完了できません。
JET_errSessionSharingViolation	同一のセッションを、同時に複数のスレッドで使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errTermInProgress	セッションに関連付けられたインスタンスがシャットダウン中のため、操作を完了できません。
JET_errTransReadOnly	読み取り専用トランザクションのスコープ内では、更新を実行できません。読み取り専用トランザクションとは、JET_bitTransactionReadOnly を指定した JetBeginTransaction2 の呼び出しによって開始されたトランザクションです。このエラーは Windows XP 以降のリリースでのみ返されます。

成功した場合、指定されたデータベース内の指定されたテーブルの名前は、新しい名前に永続的に変更されます。

失敗した場合、データベースの状態は変更されません。

要件

要件	値
クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetRenameTableW (Unicode) および JetRenameTableA (ANSI) として実装されています。

各言語での呼び出し定義

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetRenameTableW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szName,
    WORD* szNameNew
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetRenameTableW(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    ref ushort szName,   // WORD*
    ref ushort szNameNew   // WORD*
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetRenameTableW(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    ByRef szName As UShort,   ' WORD*
    ByRef szNameNew As UShort   ' WORD*
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szName : WORD*
' szNameNew : WORD*
Declare PtrSafe Function JetRenameTableW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByRef szName As Integer, _
    ByRef szNameNew As Integer) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetRenameTableW = ctypes.windll.esent.JetRenameTableW
JetRenameTableW.restype = ctypes.c_int
JetRenameTableW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # szName : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # szNameNew : WORD*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetRenameTableW = Fiddle::Function.new(
  lib['JetRenameTableW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szName : WORD*
    Fiddle::TYPE_VOIDP,  # szNameNew : WORD*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetRenameTableW(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szName: *mut u16,  // WORD*
        szNameNew: *mut u16  // WORD*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetRenameTableW(UIntPtr sesid, uint dbid, ref ushort szName, ref ushort szNameNew);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetRenameTableW' -Namespace Win32 -PassThru
# $api::JetRenameTableW(sesid, dbid, szName, szNameNew)

#uselib "ESENT.dll"
#func global JetRenameTableW "JetRenameTableW" wptr, wptr, wptr, wptr
; JetRenameTableW sesid, dbid, varptr(szName), varptr(szNameNew)   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; dbid : DWORD -> "wptr"
; szName : WORD* -> "wptr"
; szNameNew : WORD* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetRenameTableW "JetRenameTableW" sptr, int, var, var
; res = JetRenameTableW(sesid, dbid, szName, szNameNew)
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; szName : WORD* -> "var"
; szNameNew : WORD* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetRenameTableW "JetRenameTableW" sptr, int, sptr, sptr
; res = JetRenameTableW(sesid, dbid, varptr(szName), varptr(szNameNew))
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; szName : WORD* -> "sptr"
; szNameNew : WORD* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。