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

JetGetBookmark

関数
現在のレコードを一意に示すブックマークを取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetGetBookmark(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void* pvBookmark,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前方向説明
sesidJET_SESIDinブックマーク取得を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDinカレントレコードのブックマークを取得する対象テーブルのカーソルハンドル。
pvBookmarkvoid*outoptional取得したブックマークを受け取る出力バッファポインタ。NULLで必要サイズ照会が可能である。
cbMaxDWORDinpvBookmarkバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptionalブックマークの実バイト長を受け取る出力ポインタ。NULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetBookmark(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void* pvBookmark,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetGetBookmark(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr pvBookmark,   // void* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual   // DWORD* optional, out
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetGetBookmark(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    pvBookmark As IntPtr,   ' void* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' pvBookmark : void* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
Declare PtrSafe Function JetGetBookmark Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal pvBookmark As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetBookmark = ctypes.windll.esent.JetGetBookmark
JetGetBookmark.restype = ctypes.c_int
JetGetBookmark.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(None),  # pvBookmark : void* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetBookmark = esent.NewProc("JetGetBookmark")
)

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

extern "esent" fn JetGetBookmark(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    pvBookmark: ?*anyopaque, // void* optional, out
    cbMax: u32, // DWORD
    pcbActual: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc JetGetBookmark(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    pvBookmark: pointer,  # void* optional, out
    cbMax: uint32,  # DWORD
    pcbActual: ptr uint32  # DWORD* optional, out
): int32 {.importc: "JetGetBookmark", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetBookmark(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    void* pvBookmark,   // void* optional, out
    uint cbMax,   // DWORD
    uint* pcbActual   // DWORD* optional, out
);
ccall((:JetGetBookmark, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      sesid, tableid, pvBookmark, cbMax, pcbActual)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# pvBookmark : void* optional, out -> Ptr{Cvoid}
# cbMax : DWORD -> UInt32
# pcbActual : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetBookmark(
    uintptr_t sesid,
    uintptr_t tableid,
    void* pvBookmark,
    uint32_t cbMax,
    uint32_t* pcbActual);
]]
local esent = ffi.load("esent")
-- esent.JetGetBookmark(sesid, tableid, pvBookmark, cbMax, pcbActual)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- pvBookmark : void* optional, out
-- cbMax : DWORD
-- pcbActual : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetBookmark = lib.func('__stdcall', 'JetGetBookmark', 'int32_t', ['uintptr_t', 'uintptr_t', 'void *', 'uint32_t', 'uint32_t *']);
// JetGetBookmark(sesid, tableid, pvBookmark, cbMax, pcbActual)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// pvBookmark : void* optional, out -> 'void *'
// cbMax : DWORD -> 'uint32_t'
// pcbActual : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetBookmark: { parameters: ["usize", "usize", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetGetBookmark(sesid, tableid, pvBookmark, cbMax, pcbActual)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// pvBookmark : void* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// pcbActual : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetBookmark(
    size_t sesid,
    size_t tableid,
    void* pvBookmark,
    uint32_t cbMax,
    uint32_t* pcbActual);
C, "ESENT.dll");
// $ffi->JetGetBookmark(sesid, tableid, pvBookmark, cbMax, pcbActual);
// sesid : JET_SESID
// tableid : JET_TABLEID
// pvBookmark : void* optional, out
// cbMax : DWORD
// pcbActual : DWORD* optional, out
// 構造体/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 JetGetBookmark(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        Pointer pvBookmark,   // void* optional, out
        int cbMax,   // DWORD
        IntByReference pcbActual   // DWORD* optional, out
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetBookmark = JetGetBookmark(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    pvBookmark : Void*,   # void* optional, out
    cbMax : UInt32,   # DWORD
    pcbActual : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetGetBookmarkNative = Int32 Function(UintPtr, UintPtr, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef JetGetBookmarkDart = int Function(int, int, Pointer<Void>, int, Pointer<Uint32>);
final JetGetBookmark = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetBookmarkNative, JetGetBookmarkDart>('JetGetBookmark');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// pvBookmark : void* optional, out -> Pointer<Void>
// cbMax : DWORD -> Uint32
// pcbActual : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetBookmark(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  pvBookmark: Pointer;   // void* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetBookmark';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetBookmark"
  c_JetGetBookmark :: CUIntPtr -> CUIntPtr -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- pvBookmark : void* optional, out -> Ptr ()
-- cbMax : DWORD -> Word32
-- pcbActual : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetbookmark =
  foreign "JetGetBookmark"
    (size_t @-> size_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pvBookmark : void* optional, out -> (ptr void) *)
(* cbMax : DWORD -> uint32_t *)
(* pcbActual : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetGetBookmark" jet-get-bookmark :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (pv-bookmark :pointer)   ; void* optional, out
  (cb-max :uint32)   ; DWORD
  (pcb-actual :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetBookmark = Win32::API::More->new('ESENT',
    'int JetGetBookmark(WPARAM sesid, WPARAM tableid, LPVOID pvBookmark, DWORD cbMax, LPVOID pcbActual)');
# my $ret = $JetGetBookmark->Call($sesid, $tableid, $pvBookmark, $cbMax, $pcbActual);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pvBookmark : void* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。