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

JetGetLogInfoA

関数
外部バックアップ対象のログファイル一覧を取得する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetGetLogInfoA(
    CHAR* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前方向説明
szzLogsCHAR*outoptionalバックアップ対象のログファイル一覧を受け取る出力ANSI文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMaxDWORDinszzLogsバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptional実際に必要/書き込まれたバイト数を受け取る出力ポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetLogInfoA(
    CHAR* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetLogInfoA(
    IntPtr szzLogs,   // CHAR* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual   // DWORD* optional, out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetLogInfoA(
    szzLogs As IntPtr,   ' CHAR* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' szzLogs : CHAR* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
Declare PtrSafe Function JetGetLogInfoA Lib "esent" ( _
    ByVal szzLogs As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetLogInfoA = ctypes.windll.esent.JetGetLogInfoA
JetGetLogInfoA.restype = ctypes.c_int
JetGetLogInfoA.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # szzLogs : CHAR* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetLogInfoA = esent.NewProc("JetGetLogInfoA")
)

// szzLogs (CHAR* optional, out), cbMax (DWORD), pcbActual (DWORD* optional, out)
r1, _, err := procJetGetLogInfoA.Call(
	uintptr(szzLogs),
	uintptr(cbMax),
	uintptr(pcbActual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetLogInfoA(
  szzLogs: Pointer;   // CHAR* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetLogInfoA';
result := DllCall("ESENT\JetGetLogInfoA"
    , "Ptr", szzLogs   ; CHAR* optional, out
    , "UInt", cbMax   ; DWORD
    , "Ptr", pcbActual   ; DWORD* optional, out
    , "Int")   ; return: INT
●JetGetLogInfoA(szzLogs, cbMax, pcbActual) = DLL("ESENT.dll", "int JetGetLogInfoA(void*, dword, void*)")
# 呼び出し: JetGetLogInfoA(szzLogs, cbMax, pcbActual)
# szzLogs : CHAR* optional, out -> "void*"
# cbMax : DWORD -> "dword"
# pcbActual : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetGetLogInfoA(
    szzLogs: [*c]i8, // CHAR* optional, out
    cbMax: u32, // DWORD
    pcbActual: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc JetGetLogInfoA(
    szzLogs: ptr int8,  # CHAR* optional, out
    cbMax: uint32,  # DWORD
    pcbActual: ptr uint32  # DWORD* optional, out
): int32 {.importc: "JetGetLogInfoA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetLogInfoA(
    byte* szzLogs,   // CHAR* optional, out
    uint cbMax,   // DWORD
    uint* pcbActual   // DWORD* optional, out
);
ccall((:JetGetLogInfoA, "ESENT.dll"), stdcall, Int32,
      (Ptr{Int8}, UInt32, Ptr{UInt32}),
      szzLogs, cbMax, pcbActual)
# szzLogs : CHAR* optional, out -> Ptr{Int8}
# cbMax : DWORD -> UInt32
# pcbActual : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetLogInfoA(
    int8_t* szzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual);
]]
local esent = ffi.load("esent")
-- esent.JetGetLogInfoA(szzLogs, cbMax, pcbActual)
-- szzLogs : CHAR* optional, out
-- cbMax : DWORD
-- pcbActual : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetLogInfoA = lib.func('__stdcall', 'JetGetLogInfoA', 'int32_t', ['int8_t *', 'uint32_t', 'uint32_t *']);
// JetGetLogInfoA(szzLogs, cbMax, pcbActual)
// szzLogs : CHAR* optional, out -> 'int8_t *'
// cbMax : DWORD -> 'uint32_t'
// pcbActual : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetLogInfoA: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetGetLogInfoA(szzLogs, cbMax, pcbActual)
// szzLogs : CHAR* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// pcbActual : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetLogInfoA(
    int8_t* szzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual);
C, "ESENT.dll");
// $ffi->JetGetLogInfoA(szzLogs, cbMax, pcbActual);
// szzLogs : CHAR* optional, out
// cbMax : DWORD
// pcbActual : DWORD* optional, 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.ASCII_OPTIONS);
    int JetGetLogInfoA(
        byte[] szzLogs,   // CHAR* optional, out
        int cbMax,   // DWORD
        IntByReference pcbActual   // DWORD* optional, out
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetLogInfoA = JetGetLogInfoA(
    szzLogs : Int8*,   # CHAR* optional, out
    cbMax : UInt32,   # DWORD
    pcbActual : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetGetLogInfoANative = Int32 Function(Pointer<Int8>, Uint32, Pointer<Uint32>);
typedef JetGetLogInfoADart = int Function(Pointer<Int8>, int, Pointer<Uint32>);
final JetGetLogInfoA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetLogInfoANative, JetGetLogInfoADart>('JetGetLogInfoA');
// szzLogs : CHAR* optional, out -> Pointer<Int8>
// cbMax : DWORD -> Uint32
// pcbActual : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetLogInfoA(
  szzLogs: Pointer;   // CHAR* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetLogInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetLogInfoA"
  c_JetGetLogInfoA :: Ptr Int8 -> Word32 -> Ptr Word32 -> IO Int32
-- szzLogs : CHAR* optional, out -> Ptr Int8
-- cbMax : DWORD -> Word32
-- pcbActual : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetloginfoa =
  foreign "JetGetLogInfoA"
    ((ptr int8_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* szzLogs : CHAR* optional, out -> (ptr int8_t) *)
(* cbMax : DWORD -> uint32_t *)
(* pcbActual : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetGetLogInfoA" jet-get-log-info-a :convention :stdcall) :int32
  (szz-logs :pointer)   ; CHAR* optional, out
  (cb-max :uint32)   ; DWORD
  (pcb-actual :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetLogInfoA = Win32::API::More->new('ESENT',
    'int JetGetLogInfoA(LPVOID szzLogs, DWORD cbMax, LPVOID pcbActual)');
# my $ret = $JetGetLogInfoA->Call($szzLogs, $cbMax, $pcbActual);
# szzLogs : CHAR* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い