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

JetOSSnapshotPrepare

関数
ESEのボリュームシャドウコピー用スナップショットセッションを開始する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetOSSnapshotPrepare(
    JET_OSSNAPID* psnapId,
    DWORD grbit
);

パラメーター

名前方向説明
psnapIdJET_OSSNAPID*out新規に生成されるスナップショットセッション識別子を受け取る出力ポインタ。
grbitDWORDinJET_bitContinueAfterThaw等、スナップショット動作を制御するフラグ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetOSSnapshotPrepare(
    JET_OSSNAPID* psnapId,
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetOSSnapshotPrepare(
    out UIntPtr psnapId,   // JET_OSSNAPID* out
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetOSSnapshotPrepare(
    <Out> ByRef psnapId As UIntPtr,   ' JET_OSSNAPID* out
    grbit As UInteger   ' DWORD
) As Integer
End Function
' psnapId : JET_OSSNAPID* out
' grbit : DWORD
Declare PtrSafe Function JetOSSnapshotPrepare Lib "esent" ( _
    ByRef psnapId 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

JetOSSnapshotPrepare = ctypes.windll.esent.JetOSSnapshotPrepare
JetOSSnapshotPrepare.restype = ctypes.c_int
JetOSSnapshotPrepare.argtypes = [
    ctypes.c_void_p,  # psnapId : JET_OSSNAPID* out
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetOSSnapshotPrepare = esent.NewProc("JetOSSnapshotPrepare")
)

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

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

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

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