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

JetOSSnapshotPrepareInstance

関数
指定ESEインスタンスをスナップショットに追加する準備を行う。
DLLESENT.dll呼出規約winapi

シグネチャ

// ESENT.dll
#include <windows.h>

INT JetOSSnapshotPrepareInstance(
    JET_OSSNAPID snapId,
    JET_INSTANCE instance,
    DWORD grbit
);

パラメーター

名前方向説明
snapIdJET_OSSNAPIDinJetOSSnapshotPrepareで取得したスナップショットセッション識別子。
instanceJET_INSTANCEinスナップショットに追加する対象のJETインスタンスハンドル。
grbitDWORDin予約済み。通常は0を指定するフラグ引数。

戻り値の型: INT

各言語での呼び出し定義

// ESENT.dll
#include <windows.h>

INT JetOSSnapshotPrepareInstance(
    JET_OSSNAPID snapId,
    JET_INSTANCE instance,
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetOSSnapshotPrepareInstance(
    UIntPtr snapId,   // JET_OSSNAPID
    UIntPtr instance,   // JET_INSTANCE
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetOSSnapshotPrepareInstance(
    snapId As UIntPtr,   ' JET_OSSNAPID
    instance As UIntPtr,   ' JET_INSTANCE
    grbit As UInteger   ' DWORD
) As Integer
End Function
' snapId : JET_OSSNAPID
' instance : JET_INSTANCE
' grbit : DWORD
Declare PtrSafe Function JetOSSnapshotPrepareInstance Lib "esent" ( _
    ByVal snapId As LongPtr, _
    ByVal instance 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

JetOSSnapshotPrepareInstance = ctypes.windll.esent.JetOSSnapshotPrepareInstance
JetOSSnapshotPrepareInstance.restype = ctypes.c_int
JetOSSnapshotPrepareInstance.argtypes = [
    ctypes.c_size_t,  # snapId : JET_OSSNAPID
    ctypes.c_size_t,  # instance : JET_INSTANCE
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOSSnapshotPrepareInstance = Fiddle::Function.new(
  lib['JetOSSnapshotPrepareInstance'],
  [
    Fiddle::TYPE_UINTPTR_T,  # snapId : JET_OSSNAPID
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetOSSnapshotPrepareInstance(
        snapId: usize,  // JET_OSSNAPID
        instance: usize,  // JET_INSTANCE
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetOSSnapshotPrepareInstance(UIntPtr snapId, UIntPtr instance, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOSSnapshotPrepareInstance' -Namespace Win32 -PassThru
# $api::JetOSSnapshotPrepareInstance(snapId, instance, grbit)
#uselib "ESENT.dll"
#func global JetOSSnapshotPrepareInstance "JetOSSnapshotPrepareInstance" sptr, sptr, sptr
; JetOSSnapshotPrepareInstance snapId, instance, grbit   ; 戻り値は stat
; snapId : JET_OSSNAPID -> "sptr"
; instance : JET_INSTANCE -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetOSSnapshotPrepareInstance "JetOSSnapshotPrepareInstance" sptr, sptr, int
; res = JetOSSnapshotPrepareInstance(snapId, instance, grbit)
; snapId : JET_OSSNAPID -> "sptr"
; instance : JET_INSTANCE -> "sptr"
; grbit : DWORD -> "int"
; INT JetOSSnapshotPrepareInstance(JET_OSSNAPID snapId, JET_INSTANCE instance, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetOSSnapshotPrepareInstance "JetOSSnapshotPrepareInstance" intptr, intptr, int
; res = JetOSSnapshotPrepareInstance(snapId, instance, grbit)
; snapId : JET_OSSNAPID -> "intptr"
; instance : JET_INSTANCE -> "intptr"
; grbit : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetOSSnapshotPrepareInstance = esent.NewProc("JetOSSnapshotPrepareInstance")
)

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

extern "esent" fn JetOSSnapshotPrepareInstance(
    snapId: usize, // JET_OSSNAPID
    instance: usize, // JET_INSTANCE
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetOSSnapshotPrepareInstance(
    snapId: uint,  # JET_OSSNAPID
    instance: uint,  # JET_INSTANCE
    grbit: uint32  # DWORD
): int32 {.importc: "JetOSSnapshotPrepareInstance", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetOSSnapshotPrepareInstance(
    size_t snapId,   // JET_OSSNAPID
    size_t instance,   // JET_INSTANCE
    uint grbit   // DWORD
);
ccall((:JetOSSnapshotPrepareInstance, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, UInt32),
      snapId, instance, grbit)
# snapId : JET_OSSNAPID -> Csize_t
# instance : JET_INSTANCE -> Csize_t
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetOSSnapshotPrepareInstance(
    uintptr_t snapId,
    uintptr_t instance,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetOSSnapshotPrepareInstance(snapId, instance, grbit)
-- snapId : JET_OSSNAPID
-- instance : JET_INSTANCE
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetOSSnapshotPrepareInstance = lib.func('__stdcall', 'JetOSSnapshotPrepareInstance', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint32_t']);
// JetOSSnapshotPrepareInstance(snapId, instance, grbit)
// snapId : JET_OSSNAPID -> 'uintptr_t'
// instance : JET_INSTANCE -> 'uintptr_t'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetOSSnapshotPrepareInstance: { parameters: ["usize", "usize", "u32"], result: "i32" },
});
// lib.symbols.JetOSSnapshotPrepareInstance(snapId, instance, grbit)
// snapId : JET_OSSNAPID -> "usize"
// instance : JET_INSTANCE -> "usize"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetOSSnapshotPrepareInstance(
    size_t snapId,
    size_t instance,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetOSSnapshotPrepareInstance(snapId, instance, grbit);
// snapId : JET_OSSNAPID
// instance : JET_INSTANCE
// 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);
    int JetOSSnapshotPrepareInstance(
        long snapId,   // JET_OSSNAPID
        long instance,   // JET_INSTANCE
        int grbit   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetOSSnapshotPrepareInstance = JetOSSnapshotPrepareInstance(
    snapId : LibC::SizeT,   # JET_OSSNAPID
    instance : LibC::SizeT,   # JET_INSTANCE
    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 JetOSSnapshotPrepareInstanceNative = Int32 Function(UintPtr, UintPtr, Uint32);
typedef JetOSSnapshotPrepareInstanceDart = int Function(int, int, int);
final JetOSSnapshotPrepareInstance = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetOSSnapshotPrepareInstanceNative, JetOSSnapshotPrepareInstanceDart>('JetOSSnapshotPrepareInstance');
// snapId : JET_OSSNAPID -> UintPtr
// instance : JET_INSTANCE -> UintPtr
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetOSSnapshotPrepareInstance(
  snapId: NativeUInt;   // JET_OSSNAPID
  instance: NativeUInt;   // JET_INSTANCE
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOSSnapshotPrepareInstance';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetOSSnapshotPrepareInstance"
  c_JetOSSnapshotPrepareInstance :: CUIntPtr -> CUIntPtr -> Word32 -> IO Int32
-- snapId : JET_OSSNAPID -> CUIntPtr
-- instance : JET_INSTANCE -> CUIntPtr
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetossnapshotprepareinstance =
  foreign "JetOSSnapshotPrepareInstance"
    (size_t @-> size_t @-> uint32_t @-> returning int32_t)
(* snapId : JET_OSSNAPID -> size_t *)
(* instance : JET_INSTANCE -> size_t *)
(* 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 ("JetOSSnapshotPrepareInstance" jet-ossnapshot-prepare-instance :convention :stdcall) :int32
  (snap-id :uint64)   ; JET_OSSNAPID
  (instance :uint64)   ; JET_INSTANCE
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetOSSnapshotPrepareInstance = Win32::API::More->new('ESENT',
    'int JetOSSnapshotPrepareInstance(WPARAM snapId, WPARAM instance, DWORD grbit)');
# my $ret = $JetOSSnapshotPrepareInstance->Call($snapId, $instance, $grbit);
# snapId : JET_OSSNAPID -> WPARAM
# instance : JET_INSTANCE -> WPARAM
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。