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

JetGetTruncateLogInfoInstanceA

関数
切り捨て可能なログファイル一覧を取得する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetGetTruncateLogInfoInstanceA(
    JET_INSTANCE instance,
    CHAR* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前型方向説明
instanceJET_INSTANCEin情報取得対象のインスタンスを識別するJET_INSTANCEハンドル。
szzLogsCHAR*outoptional切り詰め可能なログファイル一覧を受け取る出力ANSI文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMaxDWORDinszzLogsバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptional実際に必要/書き込まれたバイト数を受け取る出力ポインタ。

戻り値の型: INT

公式ドキュメント

JetGetTruncateLogInfoInstance 関数は、JetBeginExternalBackup によって開始されたバックアップの実行中に、バックアップが正常に完了した後で安全に削除できるトランザクション ログ ファイルの名前をインスタンスに照会するために使用します。

戻り値

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

戻りコード

説明

JET_errSuccess

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

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、複数のパラメーター値の組み合わせによって予期しない結果になりました。

Windows XP 以降: JetGetTruncateLogInfoInstance では、指定されたインスタンス ハンドルが無効な場合にこのエラーが発生することがあります。

JET_errNotInitialized

セッションに関連付けられているインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errClientRequestToStopJetService

JetStopService の呼び出しの結果として、セッションに関連付けられているインスタンス上のすべての動作が停止したため、操作を完了できません。

JET_errInstanceUnavailable

セッションに関連付けられているインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。

Windows XP: この戻り値は Windows XP で導入されました。

JET_errBackupAbortByServer

JetStopBackup の呼び出しによって現在の外部バックアップが中止されたため、操作は失敗しました。

Windows XP: この戻り値は Windows XP で導入されました。

JET_errInvalidBackupSequence

順序どおりに呼び出されなかったため、バックアップ操作は失敗しました。

JET_errNoBackup

外部バックアップが実行されていないため、操作は失敗しました。

JET_errRestoreInProgress

セッションに関連付けられているインスタンスで復元操作が実行中であるため、操作を完了できません。

JET_errTermInProgress

セッションに関連付けられているインスタンスがシャットダウン中であるため、操作を完了できません。

JetGetTruncateLogInfoInstance

該当インスタンスに対して JetOpenFile を使用して作成された、未解放のファイル ハンドルがあります。

この関数が成功すると、バックアップが正常に完了した後に安全に削除できるトランザクション ログ ファイルのセットに関する要求された情報が、指定された出力バッファーに格納されます。バックアップのステート マシンは、データベース ファイルのバックアップが以降は許可されない状態へと進みます。この時点より後は、データベース パッチ ファイルとトランザクション ログ ファイルのみをバックアップのために開くことができます。

この関数が失敗した場合、出力バッファーの状態は未定義です。この失敗により、そのインスタンスのバックアップ処理全体がキャンセルされます。

解説

この API は、バックアップ ファイル セットに含めるべきファイルの完全な一覧を格納するには出力バッファーが小さすぎる場合でも、エラーや警告を返しません。アプリケーションでは常に、この一覧の実際のサイズを受け取るためのバッファーを用意し、その情報を使って一覧が切り詰められたかどうかを判断してください。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionContext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2

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

各言語での呼び出し定義

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

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

JetGetTruncateLogInfoInstanceA = ctypes.windll.esent.JetGetTruncateLogInfoInstanceA
JetGetTruncateLogInfoInstanceA.restype = ctypes.c_int
JetGetTruncateLogInfoInstanceA.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    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')
JetGetTruncateLogInfoInstanceA = Fiddle::Function.new(
  lib['JetGetTruncateLogInfoInstanceA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    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 JetGetTruncateLogInfoInstanceA(
        instance: usize,  // JET_INSTANCE
        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 JetGetTruncateLogInfoInstanceA(UIntPtr instance, IntPtr szzLogs, uint cbMax, IntPtr pcbActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetTruncateLogInfoInstanceA' -Namespace Win32 -PassThru
# $api::JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
#uselib "ESENT.dll"
#func global JetGetTruncateLogInfoInstanceA "JetGetTruncateLogInfoInstanceA" sptr, sptr, sptr, sptr
; JetGetTruncateLogInfoInstanceA instance, varptr(szzLogs), cbMax, varptr(pcbActual)   ; 戻り値は stat
; instance : JET_INSTANCE -> "sptr"
; szzLogs : CHAR* optional, out -> "sptr"
; cbMax : DWORD -> "sptr"
; pcbActual : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetTruncateLogInfoInstanceA "JetGetTruncateLogInfoInstanceA" sptr, var, int, var
; res = JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
; instance : JET_INSTANCE -> "sptr"
; szzLogs : CHAR* optional, out -> "var"
; cbMax : DWORD -> "int"
; pcbActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetTruncateLogInfoInstanceA(JET_INSTANCE instance, CHAR* szzLogs, DWORD cbMax, DWORD* pcbActual)
#uselib "ESENT.dll"
#cfunc global JetGetTruncateLogInfoInstanceA "JetGetTruncateLogInfoInstanceA" intptr, var, int, var
; res = JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
; instance : JET_INSTANCE -> "intptr"
; 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")
	procJetGetTruncateLogInfoInstanceA = esent.NewProc("JetGetTruncateLogInfoInstanceA")
)

// instance (JET_INSTANCE), szzLogs (CHAR* optional, out), cbMax (DWORD), pcbActual (DWORD* optional, out)
r1, _, err := procJetGetTruncateLogInfoInstanceA.Call(
	uintptr(instance),
	uintptr(szzLogs),
	uintptr(cbMax),
	uintptr(pcbActual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetTruncateLogInfoInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  szzLogs: Pointer;   // CHAR* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTruncateLogInfoInstanceA';
result := DllCall("ESENT\JetGetTruncateLogInfoInstanceA"
    , "UPtr", instance   ; JET_INSTANCE
    , "Ptr", szzLogs   ; CHAR* optional, out
    , "UInt", cbMax   ; DWORD
    , "Ptr", pcbActual   ; DWORD* optional, out
    , "Int")   ; return: INT
●JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual) = DLL("ESENT.dll", "int JetGetTruncateLogInfoInstanceA(int, void*, dword, void*)")
# 呼び出し: JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
# instance : JET_INSTANCE -> "int"
# 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 JetGetTruncateLogInfoInstanceA(
    instance: usize, // JET_INSTANCE
    szzLogs: [*c]i8, // CHAR* optional, out
    cbMax: u32, // DWORD
    pcbActual: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc JetGetTruncateLogInfoInstanceA(
    instance: uint,  # JET_INSTANCE
    szzLogs: ptr int8,  # CHAR* optional, out
    cbMax: uint32,  # DWORD
    pcbActual: ptr uint32  # DWORD* optional, out
): int32 {.importc: "JetGetTruncateLogInfoInstanceA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetTruncateLogInfoInstanceA(
    size_t instance,   // JET_INSTANCE
    byte* szzLogs,   // CHAR* optional, out
    uint cbMax,   // DWORD
    uint* pcbActual   // DWORD* optional, out
);
ccall((:JetGetTruncateLogInfoInstanceA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{Int8}, UInt32, Ptr{UInt32}),
      instance, szzLogs, cbMax, pcbActual)
# instance : JET_INSTANCE -> Csize_t
# 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 JetGetTruncateLogInfoInstanceA(
    uintptr_t instance,
    int8_t* szzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual);
]]
local esent = ffi.load("esent")
-- esent.JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
-- instance : JET_INSTANCE
-- 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 JetGetTruncateLogInfoInstanceA = lib.func('__stdcall', 'JetGetTruncateLogInfoInstanceA', 'int32_t', ['uintptr_t', 'int8_t *', 'uint32_t', 'uint32_t *']);
// JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
// instance : JET_INSTANCE -> 'uintptr_t'
// 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", {
  JetGetTruncateLogInfoInstanceA: { parameters: ["usize", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual)
// instance : JET_INSTANCE -> "usize"
// 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 JetGetTruncateLogInfoInstanceA(
    size_t instance,
    int8_t* szzLogs,
    uint32_t cbMax,
    uint32_t* pcbActual);
C, "ESENT.dll");
// $ffi->JetGetTruncateLogInfoInstanceA(instance, szzLogs, cbMax, pcbActual);
// instance : JET_INSTANCE
// 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 JetGetTruncateLogInfoInstanceA(
        long instance,   // JET_INSTANCE
        byte[] szzLogs,   // CHAR* optional, out
        int cbMax,   // DWORD
        IntByReference pcbActual   // DWORD* optional, out
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetTruncateLogInfoInstanceA = JetGetTruncateLogInfoInstanceA(
    instance : LibC::SizeT,   # JET_INSTANCE
    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 JetGetTruncateLogInfoInstanceANative = Int32 Function(UintPtr, Pointer<Int8>, Uint32, Pointer<Uint32>);
typedef JetGetTruncateLogInfoInstanceADart = int Function(int, Pointer<Int8>, int, Pointer<Uint32>);
final JetGetTruncateLogInfoInstanceA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetTruncateLogInfoInstanceANative, JetGetTruncateLogInfoInstanceADart>('JetGetTruncateLogInfoInstanceA');
// instance : JET_INSTANCE -> UintPtr
// szzLogs : CHAR* optional, out -> Pointer<Int8>
// cbMax : DWORD -> Uint32
// pcbActual : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetTruncateLogInfoInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  szzLogs: Pointer;   // CHAR* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTruncateLogInfoInstanceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetTruncateLogInfoInstanceA"
  c_JetGetTruncateLogInfoInstanceA :: CUIntPtr -> Ptr Int8 -> Word32 -> Ptr Word32 -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- 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 jetgettruncateloginfoinstancea =
  foreign "JetGetTruncateLogInfoInstanceA"
    (size_t @-> (ptr int8_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_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 ("JetGetTruncateLogInfoInstanceA" jet-get-truncate-log-info-instance-a :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (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 $JetGetTruncateLogInfoInstanceA = Win32::API::More->new('ESENT',
    'int JetGetTruncateLogInfoInstanceA(WPARAM instance, LPVOID szzLogs, DWORD cbMax, LPVOID pcbActual)');
# my $ret = $JetGetTruncateLogInfoInstanceA->Call($instance, $szzLogs, $cbMax, $pcbActual);
# instance : JET_INSTANCE -> WPARAM
# szzLogs : CHAR* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い