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

JetOSSnapshotFreezeW

関数
スナップショット作成のためESEインスタンスの書き込みを凍結する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetOSSnapshotFreezeW(
    JET_OSSNAPID snapId,
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_W** paInstanceInfo,
    DWORD grbit
);

パラメーター

名前型方向説明
snapIdJET_OSSNAPIDin対象のスナップショットセッション識別子。
pcInstanceInfoDWORD*out返されるインスタンス情報配列の要素数を受け取る出力ポインタ。
paInstanceInfoJET_INSTANCE_INFO_W**out凍結された各インスタンスの情報配列を受け取る出力ポインタ(Unicode)。
grbitDWORDin予約済み。通常は0を指定するフラグ引数。

戻り値の型: INT

公式ドキュメント

JetOSSnapshotFreeze 関数はスナップショットを開始します。スナップショットの実行中は、エンジンによるディスクへの書き込み動作は一切行われません。

戻り値

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

戻り値コード

説明

JET_errSuccess

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

JET_errInvalidParameter

出力パラメーターに指定されたポインターが NULL であるか、スナップショットセッションが無効であるか、grbit パラメーターが無効です。

JET_errOSSnapshotInvalidSequence

スナップショットセッションが、フリーズを開始できる適切な状態にありません (たとえば、このセッションで以前のフリーズが失敗している場合など)。

JET_errOSSnapshotNotAllowed

エンジンがスナップショットを実行できる状態にありません。1 つ以上のストリーミングバックアップが既に進行中であるか、1 つ以上のインスタンスが回復処理中または終了処理中です。

JET_errOSSnapshotInvalidSnapId

スナップショットセッションの識別子が無効です。

JET_errOutOfMemory

メモリ不足のため、関数は失敗しました。

JET_errOutOfThreads

フリーズを実行する新しいスレッドの開始に失敗したため、関数は失敗しました。

この関数が成功した場合、フリーズされたインスタンスに属するデータベースファイルおよびログファイルに対しては、書き込み IO は一切発行されません。また、インスタンス情報が適切に格納されるため、後で、返されたインスタンス情報配列へのポインターを指定して JetFreeBuffer を呼び出し、解放する必要があります。

この関数が失敗した場合、エンジンは通常どおり動作を継続し、IO も通常どおり発生します。フリーズが失敗した場合に JetOSSnapshotThaw を呼び出す必要はありません。また、インスタンス情報は格納されないため、このリソースを解放する必要もありません。

解説

フリーズ期間中は、アタッチされたデータベースやトランザクションログに対して書き込み IO が発行されることはありません。ただし、一時データベースやストリーミングファイルに対しては書き込み IO が発行される場合があります。

フリーズ中のデータベースおよびログファイルの状態 (ボリュームスナップショットイメージ内でファイルが取る状態) は、後でそれらのファイルを復元した場合に通常の回復処理が可能となるような状態になります。

フリーズ期間中は書き込み操作が行われないため、エンジンに対する通常の API 呼び出しがその間は停止することがあります。クライアントアプリケーションは、フリーズが発生した場合に API 呼び出しが通常より時間がかかる可能性を処理できる必要があります。

上記のような影響が生じ得るため、内部的なタイムアウトが設けられており、thaw (解凍) または abort (中止) を行う API が呼び出されなかった場合でも、そのタイムアウト後にスナップショットセッションはフリーズフェーズを終了します。タイムアウト値は JET_paramOSSnapshotTimeout システムパラメーターを使用して変更できます。なお、一般的なフリーズ間隔は 10 秒程度であり、既定のタイムアウトは 60 秒前後です。

必要条件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_INSTANCE_INFO
JET_OSSNAPID
JetOSSnapshotAbort
JetOSSnapshotPrepare
JetOSSnapshotPrepareInstance
JetOSSnapshotThaw

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 JetOSSnapshotFreezeW(
    JET_OSSNAPID snapId,
    DWORD* pcInstanceInfo,
    JET_INSTANCE_INFO_W** paInstanceInfo,
    DWORD grbit
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetOSSnapshotFreezeW(
    UIntPtr snapId,   // JET_OSSNAPID
    out uint pcInstanceInfo,   // DWORD* out
    IntPtr paInstanceInfo,   // JET_INSTANCE_INFO_W** out
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetOSSnapshotFreezeW(
    snapId As UIntPtr,   ' JET_OSSNAPID
    <Out> ByRef pcInstanceInfo As UInteger,   ' DWORD* out
    paInstanceInfo As IntPtr,   ' JET_INSTANCE_INFO_W** out
    grbit As UInteger   ' DWORD
) As Integer
End Function
' snapId : JET_OSSNAPID
' pcInstanceInfo : DWORD* out
' paInstanceInfo : JET_INSTANCE_INFO_W** out
' grbit : DWORD
Declare PtrSafe Function JetOSSnapshotFreezeW Lib "esent" ( _
    ByVal snapId As LongPtr, _
    ByRef pcInstanceInfo As Long, _
    ByVal paInstanceInfo As LongPtr, _
    ByVal grbit As Long) 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

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

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetOSSnapshotFreezeW = esent.NewProc("JetOSSnapshotFreezeW")
)

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

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

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

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

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

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

関連項目

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