Win32 API 日本語リファレンス
ホーム › Storage.Jet › JetGetInstanceInfoW

JetGetInstanceInfoW

関数
実行中の各ESEインスタンスとデータベースの情報を取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetGetInstanceInfoW(
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_W** paInstanceInfo
);

パラメーター

名前型方向説明
pcInstanceInfoDWORD*out返されるインスタンス情報配列の要素数を受け取る出力ポインタ(Unicode版)。
paInstanceInfoJET_INSTANCE_INFO_W**out実行中インスタンス情報の配列を受け取る出力ポインタ。JetFreeBufferで解放する。

戻り値の型: INT

公式ドキュメント

JetGetInstanceInfo 関数は、実行中のインスタンスに関する情報を取得します。

戻り値

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

リターンコード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれているか、他のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。このエラーは、次の場合に JetGetInstanceInfo から返されます。

  • pcInstanceInfo または paInstanceInfo が NULL である。

JET_errOutOfMemory

要求を処理するためのメモリが不足しています。

解説

データベースエンジンは JET_INSTANCE_INFO 構造体の配列を割り当てます。呼び出し元は、JetFreeBuffer を使用してこのメモリを解放する必要があります。

アクティブなインスタンスが 1 つも存在しない場合、JetGetInstanceInfo は JET_errSuccess を返し、pcInstanceInfo は値 0 を受け取ります。

要件

要件 値

クライアント

Windows Vista または Windows XP が必要です。

サーバー

Windows Server 2008 または Windows Server 2003 が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetGetInstanceInfoW (Unicode) および JetGetInstanceInfoA (ANSI) として実装されています。

関連項目

JET_ERR
JET_INSTANCE
JET_INSTANCE_INFO
JetFreeBuffer

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

INT JetGetInstanceInfoW(
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_W** paInstanceInfo
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetInstanceInfoW(
    out uint pcInstanceInfo,   // DWORD* out
    IntPtr paInstanceInfo   // JET_INSTANCE_INFO_W** out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetInstanceInfoW(
    <Out> ByRef pcInstanceInfo As UInteger,   ' DWORD* out
    paInstanceInfo As IntPtr   ' JET_INSTANCE_INFO_W** out
) As Integer
End Function
' pcInstanceInfo : DWORD* out
' paInstanceInfo : JET_INSTANCE_INFO_W** out
Declare PtrSafe Function JetGetInstanceInfoW Lib "esent" ( _
    ByRef pcInstanceInfo As Long, _
    ByVal paInstanceInfo As LongPtr) 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

JetGetInstanceInfoW = ctypes.windll.esent.JetGetInstanceInfoW
JetGetInstanceInfoW.restype = ctypes.c_int
JetGetInstanceInfoW.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pcInstanceInfo : DWORD* out
    ctypes.c_void_p,  # paInstanceInfo : JET_INSTANCE_INFO_W** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetInstanceInfoW = Fiddle::Function.new(
  lib['JetGetInstanceInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # pcInstanceInfo : DWORD* out
    Fiddle::TYPE_VOIDP,  # paInstanceInfo : JET_INSTANCE_INFO_W** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetGetInstanceInfoW(
        pcInstanceInfo: *mut u32,  // DWORD* out
        paInstanceInfo: *mut *mut JET_INSTANCE_INFO_W  // JET_INSTANCE_INFO_W** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetGetInstanceInfoW(out uint pcInstanceInfo, IntPtr paInstanceInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetInstanceInfoW' -Namespace Win32 -PassThru
# $api::JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
#uselib "ESENT.dll"
#func global JetGetInstanceInfoW "JetGetInstanceInfoW" wptr, wptr
; JetGetInstanceInfoW varptr(pcInstanceInfo), varptr(paInstanceInfo)   ; 戻り値は stat
; pcInstanceInfo : DWORD* out -> "wptr"
; paInstanceInfo : JET_INSTANCE_INFO_W** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetInstanceInfoW "JetGetInstanceInfoW" var, var
; res = JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
; pcInstanceInfo : DWORD* out -> "var"
; paInstanceInfo : JET_INSTANCE_INFO_W** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetInstanceInfoW(DWORD* pcInstanceInfo, JET_INSTANCE_INFO_W** paInstanceInfo)
#uselib "ESENT.dll"
#cfunc global JetGetInstanceInfoW "JetGetInstanceInfoW" var, var
; res = JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
; pcInstanceInfo : DWORD* out -> "var"
; paInstanceInfo : JET_INSTANCE_INFO_W** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetInstanceInfoW = esent.NewProc("JetGetInstanceInfoW")
)

// pcInstanceInfo (DWORD* out), paInstanceInfo (JET_INSTANCE_INFO_W** out)
r1, _, err := procJetGetInstanceInfoW.Call(
	uintptr(pcInstanceInfo),
	uintptr(paInstanceInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetInstanceInfoW(
  pcInstanceInfo: Pointer;   // DWORD* out
  paInstanceInfo: Pointer   // JET_INSTANCE_INFO_W** out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetInstanceInfoW';
result := DllCall("ESENT\JetGetInstanceInfoW"
    , "Ptr", pcInstanceInfo   ; DWORD* out
    , "Ptr", paInstanceInfo   ; JET_INSTANCE_INFO_W** out
    , "Int")   ; return: INT
●JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo) = DLL("ESENT.dll", "int JetGetInstanceInfoW(void*, void*)")
# 呼び出し: JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
# pcInstanceInfo : DWORD* out -> "void*"
# paInstanceInfo : JET_INSTANCE_INFO_W** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetGetInstanceInfoW(
    pcInstanceInfo: [*c]u32, // DWORD* out
    paInstanceInfo: [*c][*c]JET_INSTANCE_INFO_W // JET_INSTANCE_INFO_W** out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetInstanceInfoW(
    pcInstanceInfo: ptr uint32,  # DWORD* out
    paInstanceInfo: ptr JET_INSTANCE_INFO_W  # JET_INSTANCE_INFO_W** out
): int32 {.importc: "JetGetInstanceInfoW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetInstanceInfoW(
    uint* pcInstanceInfo,   // DWORD* out
    JET_INSTANCE_INFO_W** paInstanceInfo   // JET_INSTANCE_INFO_W** out
);
ccall((:JetGetInstanceInfoW, "ESENT.dll"), stdcall, Int32,
      (Ptr{UInt32}, Ptr{JET_INSTANCE_INFO_W}),
      pcInstanceInfo, paInstanceInfo)
# pcInstanceInfo : DWORD* out -> Ptr{UInt32}
# paInstanceInfo : JET_INSTANCE_INFO_W** out -> Ptr{JET_INSTANCE_INFO_W}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetInstanceInfoW(
    uint32_t* pcInstanceInfo,
    void* paInstanceInfo);
]]
local esent = ffi.load("esent")
-- esent.JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
-- pcInstanceInfo : DWORD* out
-- paInstanceInfo : JET_INSTANCE_INFO_W** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetInstanceInfoW = lib.func('__stdcall', 'JetGetInstanceInfoW', 'int32_t', ['uint32_t *', 'void *']);
// JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
// pcInstanceInfo : DWORD* out -> 'uint32_t *'
// paInstanceInfo : JET_INSTANCE_INFO_W** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetInstanceInfoW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo)
// pcInstanceInfo : DWORD* out -> "pointer"
// paInstanceInfo : JET_INSTANCE_INFO_W** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetInstanceInfoW(
    uint32_t* pcInstanceInfo,
    void* paInstanceInfo);
C, "ESENT.dll");
// $ffi->JetGetInstanceInfoW(pcInstanceInfo, paInstanceInfo);
// pcInstanceInfo : DWORD* out
// paInstanceInfo : JET_INSTANCE_INFO_W** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Esent extends StdCallLibrary {
    Esent INSTANCE = Native.load("esent", Esent.class, W32APIOptions.UNICODE_OPTIONS);
    int JetGetInstanceInfoW(
        IntByReference pcInstanceInfo,   // DWORD* out
        Pointer paInstanceInfo   // JET_INSTANCE_INFO_W** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetInstanceInfoW = JetGetInstanceInfoW(
    pcInstanceInfo : UInt32*,   # DWORD* out
    paInstanceInfo : JET_INSTANCE_INFO_W**   # JET_INSTANCE_INFO_W** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetGetInstanceInfoWNative = Int32 Function(Pointer<Uint32>, Pointer<Void>);
typedef JetGetInstanceInfoWDart = int Function(Pointer<Uint32>, Pointer<Void>);
final JetGetInstanceInfoW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetInstanceInfoWNative, JetGetInstanceInfoWDart>('JetGetInstanceInfoW');
// pcInstanceInfo : DWORD* out -> Pointer<Uint32>
// paInstanceInfo : JET_INSTANCE_INFO_W** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetInstanceInfoW(
  pcInstanceInfo: Pointer;   // DWORD* out
  paInstanceInfo: Pointer   // JET_INSTANCE_INFO_W** out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetInstanceInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetInstanceInfoW"
  c_JetGetInstanceInfoW :: Ptr Word32 -> Ptr () -> IO Int32
-- pcInstanceInfo : DWORD* out -> Ptr Word32
-- paInstanceInfo : JET_INSTANCE_INFO_W** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetinstanceinfow =
  foreign "JetGetInstanceInfoW"
    ((ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* pcInstanceInfo : DWORD* out -> (ptr uint32_t) *)
(* paInstanceInfo : JET_INSTANCE_INFO_W** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetGetInstanceInfoW" jet-get-instance-info-w :convention :stdcall) :int32
  (pc-instance-info :pointer)   ; DWORD* out
  (pa-instance-info :pointer))   ; JET_INSTANCE_INFO_W** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetInstanceInfoW = Win32::API::More->new('ESENT',
    'int JetGetInstanceInfoW(LPVOID pcInstanceInfo, LPVOID paInstanceInfo)');
# my $ret = $JetGetInstanceInfoW->Call($pcInstanceInfo, $paInstanceInfo);
# pcInstanceInfo : DWORD* out -> LPVOID
# paInstanceInfo : JET_INSTANCE_INFO_W** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型