ホーム › Storage.Jet › JetOSSnapshotGetFreezeInfoA

JetOSSnapshotGetFreezeInfoA

関数

ESEスナップショット凍結時のインスタンス情報を取得する(ANSI版)。

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

シグネチャ

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

INT JetOSSnapshotGetFreezeInfoA(
    JET_OSSNAPID snapId,
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_A** paInstanceInfo,
    DWORD grbit
);

パラメーター

名前	型	方向	説明
snapId	JET_OSSNAPID	in	情報を取得する対象のスナップショットセッション識別子。
pcInstanceInfo	DWORD*	out	返されるインスタンス情報配列の要素数を受け取る出力ポインタ。
paInstanceInfo	JET_INSTANCE_INFO_A**	out	凍結状態にある各インスタンスの情報配列を受け取る出力ポインタ(ANSI)。
grbit	DWORD	in	予約済み。通常は0を指定するフラグ引数。

戻り値の型: INT

公式ドキュメント

JetOSSnapshotGetFreezeInfo 関数は、任意の時点でスナップショットセッションの一部となっているインスタンスとデータベースの一覧を取得します。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errOutOfMemory	メモリ不足のため、関数は失敗しました。
JET_errInvalidParameter	pcInstanceInfo または paInstanceInfo が NULL です。
JET_errOSSnapshotInvalidSnapId	スナップショットセッションの識別子が有効ではありません。
JET_errOSSnapshotInvalidSequence	スナップショットセッションが進行中ではありません。

この関数が成功した場合、インスタンス情報が適切に設定されます。この情報は、返されたインスタンス情報配列へのポインターを指定して JetFreeBuffer を呼び出し、後で解放する必要があります。

この関数が失敗した場合、エンジンの状態は変化しません。

要件

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

各言語での呼び出し定義

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

INT JetOSSnapshotGetFreezeInfoA(
    JET_OSSNAPID snapId,
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_A** paInstanceInfo,
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetOSSnapshotGetFreezeInfoA(
    UIntPtr snapId,   // JET_OSSNAPID
    out uint pcInstanceInfo,   // DWORD* out
    IntPtr paInstanceInfo,   // JET_INSTANCE_INFO_A** out
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetOSSnapshotGetFreezeInfoA(
    snapId As UIntPtr,   ' JET_OSSNAPID
    <Out> ByRef pcInstanceInfo As UInteger,   ' DWORD* out
    paInstanceInfo As IntPtr,   ' JET_INSTANCE_INFO_A** out
    grbit As UInteger   ' DWORD
) As Integer
End Function

' snapId : JET_OSSNAPID
' pcInstanceInfo : DWORD* out
' paInstanceInfo : JET_INSTANCE_INFO_A** out
' grbit : DWORD
Declare PtrSafe Function JetOSSnapshotGetFreezeInfoA Lib "esent" ( _
    ByVal snapId As LongPtr, _
    ByRef pcInstanceInfo As Long, _
    ByVal paInstanceInfo As LongPtr, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetOSSnapshotGetFreezeInfoA = ctypes.windll.esent.JetOSSnapshotGetFreezeInfoA
JetOSSnapshotGetFreezeInfoA.restype = ctypes.c_int
JetOSSnapshotGetFreezeInfoA.argtypes = [
    ctypes.c_size_t,  # snapId : JET_OSSNAPID
    ctypes.POINTER(wintypes.DWORD),  # pcInstanceInfo : DWORD* out
    ctypes.c_void_p,  # paInstanceInfo : JET_INSTANCE_INFO_A** out
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOSSnapshotGetFreezeInfoA = Fiddle::Function.new(
  lib['JetOSSnapshotGetFreezeInfoA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # snapId : JET_OSSNAPID
    Fiddle::TYPE_VOIDP,  # pcInstanceInfo : DWORD* out
    Fiddle::TYPE_VOIDP,  # paInstanceInfo : JET_INSTANCE_INFO_A** out
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetOSSnapshotGetFreezeInfoA(
        snapId: usize,  // JET_OSSNAPID
        pcInstanceInfo: *mut u32,  // DWORD* out
        paInstanceInfo: *mut *mut JET_INSTANCE_INFO_A,  // JET_INSTANCE_INFO_A** out
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetOSSnapshotGetFreezeInfoA(UIntPtr snapId, out uint pcInstanceInfo, IntPtr paInstanceInfo, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOSSnapshotGetFreezeInfoA' -Namespace Win32 -PassThru
# $api::JetOSSnapshotGetFreezeInfoA(snapId, pcInstanceInfo, paInstanceInfo, grbit)

#uselib "ESENT.dll"
#func global JetOSSnapshotGetFreezeInfoA "JetOSSnapshotGetFreezeInfoA" sptr, sptr, sptr, sptr
; JetOSSnapshotGetFreezeInfoA snapId, varptr(pcInstanceInfo), varptr(paInstanceInfo), grbit   ; 戻り値は stat
; snapId : JET_OSSNAPID -> "sptr"
; pcInstanceInfo : DWORD* out -> "sptr"
; paInstanceInfo : JET_INSTANCE_INFO_A** out -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetOSSnapshotGetFreezeInfoA "JetOSSnapshotGetFreezeInfoA" sptr, var, var, int
; res = JetOSSnapshotGetFreezeInfoA(snapId, pcInstanceInfo, paInstanceInfo, grbit)
; snapId : JET_OSSNAPID -> "sptr"
; pcInstanceInfo : DWORD* out -> "var"
; paInstanceInfo : JET_INSTANCE_INFO_A** out -> "var"
; grbit : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetOSSnapshotGetFreezeInfoA "JetOSSnapshotGetFreezeInfoA" sptr, sptr, sptr, int
; res = JetOSSnapshotGetFreezeInfoA(snapId, varptr(pcInstanceInfo), varptr(paInstanceInfo), grbit)
; snapId : JET_OSSNAPID -> "sptr"
; pcInstanceInfo : DWORD* out -> "sptr"
; paInstanceInfo : JET_INSTANCE_INFO_A** out -> "sptr"
; grbit : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。