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

JetGetLogInfoInstance2W

関数
ログ情報構造体付きでバックアップ対象ログ一覧を取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetGetLogInfoInstance2W(
    JET_INSTANCE instance,
    WORD* wszzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual,   // optional
    JET_LOGINFO_W* pLogInfo   // optional
);

パラメーター

名前方向説明
instanceJET_INSTANCEin情報取得対象のインスタンスを識別するJET_INSTANCEハンドル。
wszzLogsWORD*outoptionalバックアップ対象のログファイル一覧を受け取る出力Unicode文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMaxDWORDinwszzLogsバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptional実際に必要/書き込まれたバイト数を受け取る出力ポインタ。
pLogInfoJET_LOGINFO_W*inoutoptionalログ世代の範囲などの追加情報を受け取るJET_LOGINFO_W構造体ポインタ。NULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetLogInfoInstance2W(
    JET_INSTANCE instance,
    WORD* wszzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual,   // optional
    JET_LOGINFO_W* pLogInfo   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetLogInfoInstance2W(
    UIntPtr instance,   // JET_INSTANCE
    IntPtr wszzLogs,   // WORD* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual,   // DWORD* optional, out
    IntPtr pLogInfo   // JET_LOGINFO_W* optional, in/out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetLogInfoInstance2W(
    instance As UIntPtr,   ' JET_INSTANCE
    wszzLogs As IntPtr,   ' WORD* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr,   ' DWORD* optional, out
    pLogInfo As IntPtr   ' JET_LOGINFO_W* optional, in/out
) As Integer
End Function
' instance : JET_INSTANCE
' wszzLogs : WORD* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
' pLogInfo : JET_LOGINFO_W* optional, in/out
Declare PtrSafe Function JetGetLogInfoInstance2W Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByVal wszzLogs As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual As LongPtr, _
    ByVal pLogInfo 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

JetGetLogInfoInstance2W = ctypes.windll.esent.JetGetLogInfoInstance2W
JetGetLogInfoInstance2W.restype = ctypes.c_int
JetGetLogInfoInstance2W.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_ushort),  # wszzLogs : WORD* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
    ctypes.c_void_p,  # pLogInfo : JET_LOGINFO_W* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetLogInfoInstance2W = esent.NewProc("JetGetLogInfoInstance2W")
)

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

extern "esent" fn JetGetLogInfoInstance2W(
    instance: usize, // JET_INSTANCE
    wszzLogs: [*c]u16, // WORD* optional, out
    cbMax: u32, // DWORD
    pcbActual: [*c]u32, // DWORD* optional, out
    pLogInfo: [*c]JET_LOGINFO_W // JET_LOGINFO_W* optional, in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetLogInfoInstance2W(
    instance: uint,  # JET_INSTANCE
    wszzLogs: ptr uint16,  # WORD* optional, out
    cbMax: uint32,  # DWORD
    pcbActual: ptr uint32,  # DWORD* optional, out
    pLogInfo: ptr JET_LOGINFO_W  # JET_LOGINFO_W* optional, in/out
): int32 {.importc: "JetGetLogInfoInstance2W", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetLogInfoInstance2W(
    size_t instance,   // JET_INSTANCE
    ushort* wszzLogs,   // WORD* optional, out
    uint cbMax,   // DWORD
    uint* pcbActual,   // DWORD* optional, out
    JET_LOGINFO_W* pLogInfo   // JET_LOGINFO_W* optional, in/out
);
ccall((:JetGetLogInfoInstance2W, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt16}, UInt32, Ptr{UInt32}, Ptr{JET_LOGINFO_W}),
      instance, wszzLogs, cbMax, pcbActual, pLogInfo)
# instance : JET_INSTANCE -> Csize_t
# wszzLogs : WORD* optional, out -> Ptr{UInt16}
# cbMax : DWORD -> UInt32
# pcbActual : DWORD* optional, out -> Ptr{UInt32}
# pLogInfo : JET_LOGINFO_W* optional, in/out -> Ptr{JET_LOGINFO_W}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetLogInfoInstance2W(
    uintptr_t instance,
    uint16_t* wszzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual,
    void* pLogInfo);
]]
local esent = ffi.load("esent")
-- esent.JetGetLogInfoInstance2W(instance, wszzLogs, cbMax, pcbActual, pLogInfo)
-- instance : JET_INSTANCE
-- wszzLogs : WORD* optional, out
-- cbMax : DWORD
-- pcbActual : DWORD* optional, out
-- pLogInfo : JET_LOGINFO_W* optional, in/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 JetGetLogInfoInstance2W = lib.func('__stdcall', 'JetGetLogInfoInstance2W', 'int32_t', ['uintptr_t', 'uint16_t *', 'uint32_t', 'uint32_t *', 'void *']);
// JetGetLogInfoInstance2W(instance, wszzLogs, cbMax, pcbActual, pLogInfo)
// instance : JET_INSTANCE -> 'uintptr_t'
// wszzLogs : WORD* optional, out -> 'uint16_t *'
// cbMax : DWORD -> 'uint32_t'
// pcbActual : DWORD* optional, out -> 'uint32_t *'
// pLogInfo : JET_LOGINFO_W* optional, in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetLogInfoInstance2W: { parameters: ["usize", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetGetLogInfoInstance2W(instance, wszzLogs, cbMax, pcbActual, pLogInfo)
// instance : JET_INSTANCE -> "usize"
// wszzLogs : WORD* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// pcbActual : DWORD* optional, out -> "pointer"
// pLogInfo : JET_LOGINFO_W* optional, in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetLogInfoInstance2W(
    size_t instance,
    uint16_t* wszzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual,
    void* pLogInfo);
C, "ESENT.dll");
// $ffi->JetGetLogInfoInstance2W(instance, wszzLogs, cbMax, pcbActual, pLogInfo);
// instance : JET_INSTANCE
// wszzLogs : WORD* optional, out
// cbMax : DWORD
// pcbActual : DWORD* optional, out
// pLogInfo : JET_LOGINFO_W* optional, in/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 JetGetLogInfoInstance2W(
        long instance,   // JET_INSTANCE
        ShortByReference wszzLogs,   // WORD* optional, out
        int cbMax,   // DWORD
        IntByReference pcbActual,   // DWORD* optional, out
        Pointer pLogInfo   // JET_LOGINFO_W* optional, in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetLogInfoInstance2W = JetGetLogInfoInstance2W(
    instance : LibC::SizeT,   # JET_INSTANCE
    wszzLogs : UInt16*,   # WORD* optional, out
    cbMax : UInt32,   # DWORD
    pcbActual : UInt32*,   # DWORD* optional, out
    pLogInfo : JET_LOGINFO_W*   # JET_LOGINFO_W* optional, in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetGetLogInfoInstance2WNative = Int32 Function(UintPtr, Pointer<Uint16>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef JetGetLogInfoInstance2WDart = int Function(int, Pointer<Uint16>, int, Pointer<Uint32>, Pointer<Void>);
final JetGetLogInfoInstance2W = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetLogInfoInstance2WNative, JetGetLogInfoInstance2WDart>('JetGetLogInfoInstance2W');
// instance : JET_INSTANCE -> UintPtr
// wszzLogs : WORD* optional, out -> Pointer<Uint16>
// cbMax : DWORD -> Uint32
// pcbActual : DWORD* optional, out -> Pointer<Uint32>
// pLogInfo : JET_LOGINFO_W* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetLogInfoInstance2W(
  instance: NativeUInt;   // JET_INSTANCE
  wszzLogs: Pointer;   // WORD* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer;   // DWORD* optional, out
  pLogInfo: Pointer   // JET_LOGINFO_W* optional, in/out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetLogInfoInstance2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetLogInfoInstance2W"
  c_JetGetLogInfoInstance2W :: CUIntPtr -> Ptr Word16 -> Word32 -> Ptr Word32 -> Ptr () -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- wszzLogs : WORD* optional, out -> Ptr Word16
-- cbMax : DWORD -> Word32
-- pcbActual : DWORD* optional, out -> Ptr Word32
-- pLogInfo : JET_LOGINFO_W* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetloginfoinstance2w =
  foreign "JetGetLogInfoInstance2W"
    (size_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* wszzLogs : WORD* optional, out -> (ptr uint16_t) *)
(* cbMax : DWORD -> uint32_t *)
(* pcbActual : DWORD* optional, out -> (ptr uint32_t) *)
(* pLogInfo : JET_LOGINFO_W* optional, in/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 ("JetGetLogInfoInstance2W" jet-get-log-info-instance2-w :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (wszz-logs :pointer)   ; WORD* optional, out
  (cb-max :uint32)   ; DWORD
  (pcb-actual :pointer)   ; DWORD* optional, out
  (p-log-info :pointer))   ; JET_LOGINFO_W* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetLogInfoInstance2W = Win32::API::More->new('ESENT',
    'int JetGetLogInfoInstance2W(WPARAM instance, LPVOID wszzLogs, DWORD cbMax, LPVOID pcbActual, LPVOID pLogInfo)');
# my $ret = $JetGetLogInfoInstance2W->Call($instance, $wszzLogs, $cbMax, $pcbActual, $pLogInfo);
# instance : JET_INSTANCE -> WPARAM
# wszzLogs : WORD* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# pLogInfo : JET_LOGINFO_W* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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