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

JetBeginSessionW

関数
ESEデータベースへのセッションを開始する。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetBeginSessionW(
    JET_INSTANCE instance,
    JET_SESID* psesid,
    WORD* szUserName,   // optional
    WORD* szPassword   // optional
);

パラメーター

名前方向説明
instanceJET_INSTANCEinセッションを開始する対象のインスタンスハンドル。
psesidJET_SESID*out生成されたセッションIDを受け取るJET_SESIDポインタ。
szUserNameWORD*inoptional認証に用いるユーザー名を指すワイド文字列(WORD*)。未使用のためNULL可。
szPasswordWORD*inoptional認証に用いるパスワードを指すワイド文字列(WORD*)。未使用のためNULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetBeginSessionW(
    JET_INSTANCE instance,
    JET_SESID* psesid,
    WORD* szUserName,   // optional
    WORD* szPassword   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetBeginSessionW(
    UIntPtr instance,   // JET_INSTANCE
    out UIntPtr psesid,   // JET_SESID* out
    IntPtr szUserName,   // WORD* optional
    IntPtr szPassword   // WORD* optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetBeginSessionW(
    instance As UIntPtr,   ' JET_INSTANCE
    <Out> ByRef psesid As UIntPtr,   ' JET_SESID* out
    szUserName As IntPtr,   ' WORD* optional
    szPassword As IntPtr   ' WORD* optional
) As Integer
End Function
' instance : JET_INSTANCE
' psesid : JET_SESID* out
' szUserName : WORD* optional
' szPassword : WORD* optional
Declare PtrSafe Function JetBeginSessionW Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByRef psesid As LongPtr, _
    ByVal szUserName As LongPtr, _
    ByVal szPassword As LongPtr) 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

JetBeginSessionW = ctypes.windll.esent.JetBeginSessionW
JetBeginSessionW.restype = ctypes.c_int
JetBeginSessionW.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.c_void_p,  # psesid : JET_SESID* out
    ctypes.POINTER(ctypes.c_ushort),  # szUserName : WORD* optional
    ctypes.POINTER(ctypes.c_ushort),  # szPassword : WORD* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBeginSessionW = esent.NewProc("JetBeginSessionW")
)

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

extern "esent" fn JetBeginSessionW(
    instance: usize, // JET_INSTANCE
    psesid: [*c]usize, // JET_SESID* out
    szUserName: [*c]u16, // WORD* optional
    szPassword: [*c]u16 // WORD* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetBeginSessionW(
    instance: uint,  # JET_INSTANCE
    psesid: ptr uint,  # JET_SESID* out
    szUserName: ptr uint16,  # WORD* optional
    szPassword: ptr uint16  # WORD* optional
): int32 {.importc: "JetBeginSessionW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetBeginSessionW(
    size_t instance,   // JET_INSTANCE
    size_t* psesid,   // JET_SESID* out
    ushort* szUserName,   // WORD* optional
    ushort* szPassword   // WORD* optional
);
ccall((:JetBeginSessionW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{Csize_t}, Ptr{UInt16}, Ptr{UInt16}),
      instance, psesid, szUserName, szPassword)
# instance : JET_INSTANCE -> Csize_t
# psesid : JET_SESID* out -> Ptr{Csize_t}
# szUserName : WORD* optional -> Ptr{UInt16}
# szPassword : WORD* optional -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBeginSessionW(
    uintptr_t instance,
    uintptr_t* psesid,
    uint16_t* szUserName,
    uint16_t* szPassword);
]]
local esent = ffi.load("esent")
-- esent.JetBeginSessionW(instance, psesid, szUserName, szPassword)
-- instance : JET_INSTANCE
-- psesid : JET_SESID* out
-- szUserName : WORD* optional
-- szPassword : WORD* optional
-- 構造体/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 JetBeginSessionW = lib.func('__stdcall', 'JetBeginSessionW', 'int32_t', ['uintptr_t', 'uintptr_t *', 'uint16_t *', 'uint16_t *']);
// JetBeginSessionW(instance, psesid, szUserName, szPassword)
// instance : JET_INSTANCE -> 'uintptr_t'
// psesid : JET_SESID* out -> 'uintptr_t *'
// szUserName : WORD* optional -> 'uint16_t *'
// szPassword : WORD* optional -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetBeginSessionW: { parameters: ["usize", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetBeginSessionW(instance, psesid, szUserName, szPassword)
// instance : JET_INSTANCE -> "usize"
// psesid : JET_SESID* out -> "pointer"
// szUserName : WORD* optional -> "pointer"
// szPassword : WORD* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBeginSessionW(
    size_t instance,
    size_t* psesid,
    uint16_t* szUserName,
    uint16_t* szPassword);
C, "ESENT.dll");
// $ffi->JetBeginSessionW(instance, psesid, szUserName, szPassword);
// instance : JET_INSTANCE
// psesid : JET_SESID* out
// szUserName : WORD* optional
// szPassword : WORD* optional
// 構造体/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 JetBeginSessionW(
        long instance,   // JET_INSTANCE
        LongByReference psesid,   // JET_SESID* out
        ShortByReference szUserName,   // WORD* optional
        ShortByReference szPassword   // WORD* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetBeginSessionW = JetBeginSessionW(
    instance : LibC::SizeT,   # JET_INSTANCE
    psesid : LibC::SizeT*,   # JET_SESID* out
    szUserName : UInt16*,   # WORD* optional
    szPassword : UInt16*   # WORD* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetBeginSessionWNative = Int32 Function(UintPtr, Pointer<UintPtr>, Pointer<Uint16>, Pointer<Uint16>);
typedef JetBeginSessionWDart = int Function(int, Pointer<UintPtr>, Pointer<Uint16>, Pointer<Uint16>);
final JetBeginSessionW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBeginSessionWNative, JetBeginSessionWDart>('JetBeginSessionW');
// instance : JET_INSTANCE -> UintPtr
// psesid : JET_SESID* out -> Pointer<UintPtr>
// szUserName : WORD* optional -> Pointer<Uint16>
// szPassword : WORD* optional -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBeginSessionW(
  instance: NativeUInt;   // JET_INSTANCE
  psesid: Pointer;   // JET_SESID* out
  szUserName: Pointer;   // WORD* optional
  szPassword: Pointer   // WORD* optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBeginSessionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetBeginSessionW"
  c_JetBeginSessionW :: CUIntPtr -> Ptr CUIntPtr -> Ptr Word16 -> Ptr Word16 -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- psesid : JET_SESID* out -> Ptr CUIntPtr
-- szUserName : WORD* optional -> Ptr Word16
-- szPassword : WORD* optional -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetbeginsessionw =
  foreign "JetBeginSessionW"
    (size_t @-> (ptr size_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* psesid : JET_SESID* out -> (ptr size_t) *)
(* szUserName : WORD* optional -> (ptr uint16_t) *)
(* szPassword : WORD* optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetBeginSessionW" jet-begin-session-w :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (psesid :pointer)   ; JET_SESID* out
  (sz-user-name :pointer)   ; WORD* optional
  (sz-password :pointer))   ; WORD* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetBeginSessionW = Win32::API::More->new('ESENT',
    'int JetBeginSessionW(WPARAM instance, LPVOID psesid, LPVOID szUserName, LPVOID szPassword)');
# my $ret = $JetBeginSessionW->Call($instance, $psesid, $szUserName, $szPassword);
# instance : JET_INSTANCE -> WPARAM
# psesid : JET_SESID* out -> LPVOID
# szUserName : WORD* optional -> LPVOID
# szPassword : WORD* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い