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

JetMakeKey

関数
検索用の検索キーをデータから構築する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetMakeKey(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void* pvData,   // optional
    DWORD cbData,
    DWORD grbit
);

パラメーター

名前方向説明
sesidJET_SESIDinキー構築を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin検索キーを構築する対象テーブルのカーソルハンドル。
pvDatavoid*inoptionalキー列に対応するデータを格納したバッファポインタ。NULLでNull値キーを構成する。
cbDataDWORDinpvDataのデータ長をバイト単位で指定する値。
grbitDWORDinキー構築動作を制御するビットフラグ。JET_bitNewKeyで新規キー開始、ワイルドカード等を指定する。

戻り値の型: INT

各言語での呼び出し定義

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

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

JetMakeKey = ctypes.windll.esent.JetMakeKey
JetMakeKey.restype = ctypes.c_int
JetMakeKey.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(None),  # pvData : void* optional
    wintypes.DWORD,  # cbData : DWORD
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetMakeKey = esent.NewProc("JetMakeKey")
)

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

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

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

let jetmakekey =
  foreign "JetMakeKey"
    (size_t @-> size_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pvData : void* optional -> (ptr void) *)
(* cbData : DWORD -> uint32_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 ("JetMakeKey" jet-make-key :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (pv-data :pointer)   ; void* optional
  (cb-data :uint32)   ; DWORD
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetMakeKey = Win32::API::More->new('ESENT',
    'int JetMakeKey(WPARAM sesid, WPARAM tableid, LPVOID pvData, DWORD cbData, DWORD grbit)');
# my $ret = $JetMakeKey->Call($sesid, $tableid, $pvData, $cbData, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pvData : void* optional -> LPVOID
# cbData : DWORD -> DWORD
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。