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

JetGetCurrentIndexW

関数
カーソルの現在のインデックス名を取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetGetCurrentIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,
    DWORD cbIndexName
);

パラメーター

名前方向説明
sesidJET_SESIDin現在インデックス取得を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin対象テーブルのカーソルハンドル。
szIndexNameWORD*out現在の有効インデックス名を受け取る出力Unicode文字列バッファポインタ。
cbIndexNameDWORDinszIndexNameバッファのサイズをバイト単位で指定する値。

戻り値の型: INT

各言語での呼び出し定義

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetGetCurrentIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,
    DWORD cbIndexName
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetCurrentIndexW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    out ushort szIndexName,   // WORD* out
    uint cbIndexName   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetCurrentIndexW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    <Out> ByRef szIndexName As UShort,   ' WORD* out
    cbIndexName As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : WORD* out
' cbIndexName : DWORD
Declare PtrSafe Function JetGetCurrentIndexW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szIndexName As Integer, _
    ByVal cbIndexName As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetCurrentIndexW = ctypes.windll.esent.JetGetCurrentIndexW
JetGetCurrentIndexW.restype = ctypes.c_int
JetGetCurrentIndexW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szIndexName : WORD* out
    wintypes.DWORD,  # cbIndexName : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetCurrentIndexW = esent.NewProc("JetGetCurrentIndexW")
)

// sesid (JET_SESID), tableid (JET_TABLEID), szIndexName (WORD* out), cbIndexName (DWORD)
r1, _, err := procJetGetCurrentIndexW.Call(
	uintptr(sesid),
	uintptr(tableid),
	uintptr(szIndexName),
	uintptr(cbIndexName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetCurrentIndexW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer;   // WORD* out
  cbIndexName: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetCurrentIndexW';
result := DllCall("ESENT\JetGetCurrentIndexW"
    , "UPtr", sesid   ; JET_SESID
    , "UPtr", tableid   ; JET_TABLEID
    , "Ptr", szIndexName   ; WORD* out
    , "UInt", cbIndexName   ; DWORD
    , "Int")   ; return: INT
●JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName) = DLL("ESENT.dll", "int JetGetCurrentIndexW(int, int, void*, dword)")
# 呼び出し: JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# szIndexName : WORD* out -> "void*"
# cbIndexName : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetGetCurrentIndexW(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szIndexName: [*c]u16, // WORD* out
    cbIndexName: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetCurrentIndexW(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szIndexName: ptr uint16,  # WORD* out
    cbIndexName: uint32  # DWORD
): int32 {.importc: "JetGetCurrentIndexW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetCurrentIndexW(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    ushort* szIndexName,   // WORD* out
    uint cbIndexName   // DWORD
);
ccall((:JetGetCurrentIndexW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{UInt16}, UInt32),
      sesid, tableid, szIndexName, cbIndexName)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szIndexName : WORD* out -> Ptr{UInt16}
# cbIndexName : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetCurrentIndexW(
    uintptr_t sesid,
    uintptr_t tableid,
    uint16_t* szIndexName,
    uint32_t cbIndexName);
]]
local esent = ffi.load("esent")
-- esent.JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szIndexName : WORD* out
-- cbIndexName : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetCurrentIndexW = lib.func('__stdcall', 'JetGetCurrentIndexW', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint16_t *', 'uint32_t']);
// JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szIndexName : WORD* out -> 'uint16_t *'
// cbIndexName : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetCurrentIndexW: { parameters: ["usize", "usize", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szIndexName : WORD* out -> "pointer"
// cbIndexName : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetCurrentIndexW(
    size_t sesid,
    size_t tableid,
    uint16_t* szIndexName,
    uint32_t cbIndexName);
C, "ESENT.dll");
// $ffi->JetGetCurrentIndexW(sesid, tableid, szIndexName, cbIndexName);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szIndexName : WORD* out
// cbIndexName : 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.UNICODE_OPTIONS);
    int JetGetCurrentIndexW(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        ShortByReference szIndexName,   // WORD* out
        int cbIndexName   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetCurrentIndexW = JetGetCurrentIndexW(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szIndexName : UInt16*,   # WORD* out
    cbIndexName : 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 JetGetCurrentIndexWNative = Int32 Function(UintPtr, UintPtr, Pointer<Uint16>, Uint32);
typedef JetGetCurrentIndexWDart = int Function(int, int, Pointer<Uint16>, int);
final JetGetCurrentIndexW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetCurrentIndexWNative, JetGetCurrentIndexWDart>('JetGetCurrentIndexW');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szIndexName : WORD* out -> Pointer<Uint16>
// cbIndexName : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetCurrentIndexW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer;   // WORD* out
  cbIndexName: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetCurrentIndexW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetCurrentIndexW"
  c_JetGetCurrentIndexW :: CUIntPtr -> CUIntPtr -> Ptr Word16 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- szIndexName : WORD* out -> Ptr Word16
-- cbIndexName : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetcurrentindexw =
  foreign "JetGetCurrentIndexW"
    (size_t @-> size_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szIndexName : WORD* out -> (ptr uint16_t) *)
(* cbIndexName : 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 ("JetGetCurrentIndexW" jet-get-current-index-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-index-name :pointer)   ; WORD* out
  (cb-index-name :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetCurrentIndexW = Win32::API::More->new('ESENT',
    'int JetGetCurrentIndexW(WPARAM sesid, WPARAM tableid, LPVOID szIndexName, DWORD cbIndexName)');
# my $ret = $JetGetCurrentIndexW->Call($sesid, $tableid, $szIndexName, $cbIndexName);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szIndexName : WORD* out -> LPVOID
# cbIndexName : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い