ホーム › Storage.Jet › JetOSSnapshotFreezeA
JetOSSnapshotFreezeA
関数スナップショット作成のためESEインスタンスの書き込みを凍結する(ANSI版)。
シグネチャ
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetOSSnapshotFreezeA(
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
各言語での呼び出し定義
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetOSSnapshotFreezeA(
JET_OSSNAPID snapId,
DWORD* pcInstanceInfo,
JET_INSTANCE_INFO_A** paInstanceInfo,
DWORD grbit
);[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetOSSnapshotFreezeA(
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 JetOSSnapshotFreezeA(
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 JetOSSnapshotFreezeA 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
JetOSSnapshotFreezeA = ctypes.windll.esent.JetOSSnapshotFreezeA
JetOSSnapshotFreezeA.restype = ctypes.c_int
JetOSSnapshotFreezeA.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')
JetOSSnapshotFreezeA = Fiddle::Function.new(
lib['JetOSSnapshotFreezeA'],
[
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 JetOSSnapshotFreezeA(
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 JetOSSnapshotFreezeA(UIntPtr snapId, out uint pcInstanceInfo, IntPtr paInstanceInfo, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOSSnapshotFreezeA' -Namespace Win32 -PassThru
# $api::JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit)#uselib "ESENT.dll"
#func global JetOSSnapshotFreezeA "JetOSSnapshotFreezeA" sptr, sptr, sptr, sptr
; JetOSSnapshotFreezeA 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 JetOSSnapshotFreezeA "JetOSSnapshotFreezeA" sptr, var, var, int ; res = JetOSSnapshotFreezeA(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 JetOSSnapshotFreezeA "JetOSSnapshotFreezeA" sptr, sptr, sptr, int ; res = JetOSSnapshotFreezeA(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(変数))。
出力引数:
; INT JetOSSnapshotFreezeA(JET_OSSNAPID snapId, DWORD* pcInstanceInfo, JET_INSTANCE_INFO_A** paInstanceInfo, DWORD grbit) #uselib "ESENT.dll" #cfunc global JetOSSnapshotFreezeA "JetOSSnapshotFreezeA" intptr, var, var, int ; res = JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit) ; snapId : JET_OSSNAPID -> "intptr" ; pcInstanceInfo : DWORD* out -> "var" ; paInstanceInfo : JET_INSTANCE_INFO_A** out -> "var" ; grbit : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT JetOSSnapshotFreezeA(JET_OSSNAPID snapId, DWORD* pcInstanceInfo, JET_INSTANCE_INFO_A** paInstanceInfo, DWORD grbit) #uselib "ESENT.dll" #cfunc global JetOSSnapshotFreezeA "JetOSSnapshotFreezeA" intptr, intptr, intptr, int ; res = JetOSSnapshotFreezeA(snapId, varptr(pcInstanceInfo), varptr(paInstanceInfo), grbit) ; snapId : JET_OSSNAPID -> "intptr" ; pcInstanceInfo : DWORD* out -> "intptr" ; paInstanceInfo : JET_INSTANCE_INFO_A** out -> "intptr" ; grbit : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetOSSnapshotFreezeA = esent.NewProc("JetOSSnapshotFreezeA")
)
// snapId (JET_OSSNAPID), pcInstanceInfo (DWORD* out), paInstanceInfo (JET_INSTANCE_INFO_A** out), grbit (DWORD)
r1, _, err := procJetOSSnapshotFreezeA.Call(
uintptr(snapId),
uintptr(pcInstanceInfo),
uintptr(paInstanceInfo),
uintptr(grbit),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetOSSnapshotFreezeA(
snapId: NativeUInt; // JET_OSSNAPID
pcInstanceInfo: Pointer; // DWORD* out
paInstanceInfo: Pointer; // JET_INSTANCE_INFO_A** out
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetOSSnapshotFreezeA';result := DllCall("ESENT\JetOSSnapshotFreezeA"
, "UPtr", snapId ; JET_OSSNAPID
, "Ptr", pcInstanceInfo ; DWORD* out
, "Ptr", paInstanceInfo ; JET_INSTANCE_INFO_A** out
, "UInt", grbit ; DWORD
, "Int") ; return: INT●JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit) = DLL("ESENT.dll", "int JetOSSnapshotFreezeA(int, void*, void*, dword)")
# 呼び出し: JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit)
# snapId : JET_OSSNAPID -> "int"
# pcInstanceInfo : DWORD* out -> "void*"
# paInstanceInfo : JET_INSTANCE_INFO_A** out -> "void*"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetOSSnapshotFreezeA(
snapId: usize, // JET_OSSNAPID
pcInstanceInfo: [*c]u32, // DWORD* out
paInstanceInfo: [*c][*c]JET_INSTANCE_INFO_A, // JET_INSTANCE_INFO_A** out
grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc JetOSSnapshotFreezeA(
snapId: uint, # JET_OSSNAPID
pcInstanceInfo: ptr uint32, # DWORD* out
paInstanceInfo: ptr JET_INSTANCE_INFO_A, # JET_INSTANCE_INFO_A** out
grbit: uint32 # DWORD
): int32 {.importc: "JetOSSnapshotFreezeA", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetOSSnapshotFreezeA(
size_t snapId, // JET_OSSNAPID
uint* pcInstanceInfo, // DWORD* out
JET_INSTANCE_INFO_A** paInstanceInfo, // JET_INSTANCE_INFO_A** out
uint grbit // DWORD
);ccall((:JetOSSnapshotFreezeA, "ESENT.dll"), stdcall, Int32,
(Csize_t, Ptr{UInt32}, Ptr{JET_INSTANCE_INFO_A}, UInt32),
snapId, pcInstanceInfo, paInstanceInfo, grbit)
# snapId : JET_OSSNAPID -> Csize_t
# pcInstanceInfo : DWORD* out -> Ptr{UInt32}
# paInstanceInfo : JET_INSTANCE_INFO_A** out -> Ptr{JET_INSTANCE_INFO_A}
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetOSSnapshotFreezeA(
uintptr_t snapId,
uint32_t* pcInstanceInfo,
void* paInstanceInfo,
uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit)
-- snapId : JET_OSSNAPID
-- pcInstanceInfo : DWORD* out
-- paInstanceInfo : JET_INSTANCE_INFO_A** out
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetOSSnapshotFreezeA = lib.func('__stdcall', 'JetOSSnapshotFreezeA', 'int32_t', ['uintptr_t', 'uint32_t *', 'void *', 'uint32_t']);
// JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit)
// snapId : JET_OSSNAPID -> 'uintptr_t'
// pcInstanceInfo : DWORD* out -> 'uint32_t *'
// paInstanceInfo : JET_INSTANCE_INFO_A** out -> 'void *'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetOSSnapshotFreezeA: { parameters: ["usize", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit)
// snapId : JET_OSSNAPID -> "usize"
// pcInstanceInfo : DWORD* out -> "pointer"
// paInstanceInfo : JET_INSTANCE_INFO_A** out -> "pointer"
// grbit : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetOSSnapshotFreezeA(
size_t snapId,
uint32_t* pcInstanceInfo,
void* paInstanceInfo,
uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetOSSnapshotFreezeA(snapId, pcInstanceInfo, paInstanceInfo, grbit);
// snapId : JET_OSSNAPID
// pcInstanceInfo : DWORD* out
// paInstanceInfo : JET_INSTANCE_INFO_A** 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.ASCII_OPTIONS);
int JetOSSnapshotFreezeA(
long snapId, // JET_OSSNAPID
IntByReference pcInstanceInfo, // DWORD* out
Pointer paInstanceInfo, // JET_INSTANCE_INFO_A** out
int grbit // DWORD
);
}@[Link("esent")]
lib LibESENT
fun JetOSSnapshotFreezeA = JetOSSnapshotFreezeA(
snapId : LibC::SizeT, # JET_OSSNAPID
pcInstanceInfo : UInt32*, # DWORD* out
paInstanceInfo : JET_INSTANCE_INFO_A**, # JET_INSTANCE_INFO_A** 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 JetOSSnapshotFreezeANative = Int32 Function(UintPtr, Pointer<Uint32>, Pointer<Void>, Uint32);
typedef JetOSSnapshotFreezeADart = int Function(int, Pointer<Uint32>, Pointer<Void>, int);
final JetOSSnapshotFreezeA = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetOSSnapshotFreezeANative, JetOSSnapshotFreezeADart>('JetOSSnapshotFreezeA');
// snapId : JET_OSSNAPID -> UintPtr
// pcInstanceInfo : DWORD* out -> Pointer<Uint32>
// paInstanceInfo : JET_INSTANCE_INFO_A** out -> Pointer<Void>
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetOSSnapshotFreezeA(
snapId: NativeUInt; // JET_OSSNAPID
pcInstanceInfo: Pointer; // DWORD* out
paInstanceInfo: Pointer; // JET_INSTANCE_INFO_A** out
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetOSSnapshotFreezeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetOSSnapshotFreezeA"
c_JetOSSnapshotFreezeA :: CUIntPtr -> Ptr Word32 -> Ptr () -> Word32 -> IO Int32
-- snapId : JET_OSSNAPID -> CUIntPtr
-- pcInstanceInfo : DWORD* out -> Ptr Word32
-- paInstanceInfo : JET_INSTANCE_INFO_A** out -> Ptr ()
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetossnapshotfreezea =
foreign "JetOSSnapshotFreezeA"
(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_A** 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 ("JetOSSnapshotFreezeA" jet-ossnapshot-freeze-a :convention :stdcall) :int32
(snap-id :uint64) ; JET_OSSNAPID
(pc-instance-info :pointer) ; DWORD* out
(pa-instance-info :pointer) ; JET_INSTANCE_INFO_A** out
(grbit :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetOSSnapshotFreezeA = Win32::API::More->new('ESENT',
'int JetOSSnapshotFreezeA(WPARAM snapId, LPVOID pcInstanceInfo, LPVOID paInstanceInfo, DWORD grbit)');
# my $ret = $JetOSSnapshotFreezeA->Call($snapId, $pcInstanceInfo, $paInstanceInfo, $grbit);
# snapId : JET_OSSNAPID -> WPARAM
# pcInstanceInfo : DWORD* out -> LPVOID
# paInstanceInfo : JET_INSTANCE_INFO_A** out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f JetOSSnapshotFreezeW (Unicode版) — スナップショット作成のためESEインスタンスの書き込みを凍結する(Unicode版)。