JetGetObjectInfoA

関数

ESEデータベース内のオブジェクトの情報を取得する（ANSI版）。

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

シグネチャ

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetObjectInfoA(
    JET_SESID sesid,
    DWORD dbid,
    DWORD objtyp,
    CHAR* szContainerName,   // optional
    CHAR* szObjectName,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象オブジェクトを含むデータベースのID。
objtyp	DWORD	in	取得対象のオブジェクト種別(JET_objtypTable等)。
szContainerName	CHAR*	inoptional	オブジェクトコンテナ名を指すANSI文字列。NULL可。
szObjectName	CHAR*	inoptional	情報を取得する対象オブジェクト名を指すANSI文字列。NULL可。
pvResult	void*	out	取得した情報を受け取る出力バッファへのポインタ。
cbMax	DWORD	in	pvResultバッファのバイトサイズ。
InfoLevel	DWORD	in	取得する情報レベル(JET_ObjInfo系定数)。

戻り値の型: INT

公式ドキュメント

JetGetObjectInfo 関数は、データベースオブジェクトに関する情報を取得します。現在はテーブルのみがサポートされています。JetGetTableInfo を使用すると、JetGetObjectInfo よりも多くの情報を取得できます。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errBufferTooSmall	cbMax で指定されたバッファーのサイズが小さすぎ、目的の情報を格納できませんでした。
JET_errInvalidName	szObjectName または szContainerName に無効な名前が指定されました。
JET_errInvalidParameter	不正なパラメーターが指定されました。InfoLevel に不正なレベルが渡された可能性があります。

解説

JetGetObjectInfo が一時テーブルの作成に成功した場合 (例えば JET_ObjInfoList や JET_ObjInfoNoStats)、呼び出し元は JetCloseTable でその一時テーブルを閉じる責任があります。

JetGetObjectInfo は現在、テーブルに関する情報の取得のみをサポートしています。

要件

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

各言語での呼び出し定義

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetObjectInfoA(
    JET_SESID sesid,
    DWORD dbid,
    DWORD objtyp,
    CHAR* szContainerName,   // optional
    CHAR* szObjectName,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetObjectInfoA(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    uint objtyp,   // DWORD
    IntPtr szContainerName,   // CHAR* optional
    IntPtr szObjectName,   // CHAR* optional
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetObjectInfoA(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    objtyp As UInteger,   ' DWORD
    szContainerName As IntPtr,   ' CHAR* optional
    szObjectName As IntPtr,   ' CHAR* optional
    pvResult As IntPtr,   ' void* out
    cbMax As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' objtyp : DWORD
' szContainerName : CHAR* optional
' szObjectName : CHAR* optional
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetObjectInfoA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByVal objtyp As Long, _
    ByVal szContainerName As LongPtr, _
    ByVal szObjectName As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbMax As Long, _
    ByVal InfoLevel As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetGetObjectInfoA = ctypes.windll.esent.JetGetObjectInfoA
JetGetObjectInfoA.restype = ctypes.c_int
JetGetObjectInfoA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    wintypes.DWORD,  # objtyp : DWORD
    ctypes.POINTER(ctypes.c_byte),  # szContainerName : CHAR* optional
    ctypes.POINTER(ctypes.c_byte),  # szObjectName : CHAR* optional
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbMax : DWORD
    wintypes.DWORD,  # InfoLevel : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetObjectInfoA = Fiddle::Function.new(
  lib['JetGetObjectInfoA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    -Fiddle::TYPE_INT,  # objtyp : DWORD
    Fiddle::TYPE_VOIDP,  # szContainerName : CHAR* optional
    Fiddle::TYPE_VOIDP,  # szObjectName : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetObjectInfoA(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        objtyp: u32,  // DWORD
        szContainerName: *mut i8,  // CHAR* optional
        szObjectName: *mut i8,  // CHAR* optional
        pvResult: *mut (),  // void* out
        cbMax: u32,  // DWORD
        InfoLevel: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetGetObjectInfoA(UIntPtr sesid, uint dbid, uint objtyp, IntPtr szContainerName, IntPtr szObjectName, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetObjectInfoA' -Namespace Win32 -PassThru
# $api::JetGetObjectInfoA(sesid, dbid, objtyp, szContainerName, szObjectName, pvResult, cbMax, InfoLevel)

#uselib "ESENT.dll"
#func global JetGetObjectInfoA "JetGetObjectInfoA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; JetGetObjectInfoA sesid, dbid, objtyp, varptr(szContainerName), varptr(szObjectName), pvResult, cbMax, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "sptr"
; objtyp : DWORD -> "sptr"
; szContainerName : CHAR* optional -> "sptr"
; szObjectName : CHAR* optional -> "sptr"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "sptr"
; InfoLevel : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetGetObjectInfoA "JetGetObjectInfoA" sptr, int, int, var, var, sptr, int, int
; res = JetGetObjectInfoA(sesid, dbid, objtyp, szContainerName, szObjectName, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; objtyp : DWORD -> "int"
; szContainerName : CHAR* optional -> "var"
; szObjectName : CHAR* optional -> "var"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetGetObjectInfoA "JetGetObjectInfoA" sptr, int, int, sptr, sptr, sptr, int, int
; res = JetGetObjectInfoA(sesid, dbid, objtyp, varptr(szContainerName), varptr(szObjectName), pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; objtyp : DWORD -> "int"
; szContainerName : CHAR* optional -> "sptr"
; szObjectName : CHAR* optional -> "sptr"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。