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

JetGetAttachInfoW

関数
外部バックアップでアタッチ済みデータベース一覧を取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetGetAttachInfoW(
    WORD* wszzDatabases,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前方向説明
wszzDatabasesWORD*outoptionalアタッチ中データベースのパス一覧を受け取る出力Unicode文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMaxDWORDinwszzDatabasesバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptional実際に必要/書き込まれたバイト数を受け取る出力ポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetAttachInfoW(
    WORD* wszzDatabases,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetAttachInfoW(
    IntPtr wszzDatabases,   // WORD* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual   // DWORD* optional, out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetAttachInfoW(
    wszzDatabases As IntPtr,   ' WORD* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' wszzDatabases : WORD* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
Declare PtrSafe Function JetGetAttachInfoW Lib "esent" ( _
    ByVal wszzDatabases As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual 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

JetGetAttachInfoW = ctypes.windll.esent.JetGetAttachInfoW
JetGetAttachInfoW.restype = ctypes.c_int
JetGetAttachInfoW.argtypes = [
    ctypes.POINTER(ctypes.c_ushort),  # wszzDatabases : WORD* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetAttachInfoW = Fiddle::Function.new(
  lib['JetGetAttachInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # wszzDatabases : WORD* optional, out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    Fiddle::TYPE_VOIDP,  # pcbActual : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetGetAttachInfoW(
        wszzDatabases: *mut u16,  // WORD* 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", CharSet = CharSet.Unicode)]
public static extern int JetGetAttachInfoW(IntPtr wszzDatabases, uint cbMax, IntPtr pcbActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetAttachInfoW' -Namespace Win32 -PassThru
# $api::JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
#uselib "ESENT.dll"
#func global JetGetAttachInfoW "JetGetAttachInfoW" wptr, wptr, wptr
; JetGetAttachInfoW varptr(wszzDatabases), cbMax, varptr(pcbActual)   ; 戻り値は stat
; wszzDatabases : WORD* optional, out -> "wptr"
; cbMax : DWORD -> "wptr"
; pcbActual : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetAttachInfoW "JetGetAttachInfoW" var, int, var
; res = JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
; wszzDatabases : WORD* optional, out -> "var"
; cbMax : DWORD -> "int"
; pcbActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetAttachInfoW(WORD* wszzDatabases, DWORD cbMax, DWORD* pcbActual)
#uselib "ESENT.dll"
#cfunc global JetGetAttachInfoW "JetGetAttachInfoW" var, int, var
; res = JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
; wszzDatabases : WORD* optional, out -> "var"
; cbMax : DWORD -> "int"
; pcbActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetAttachInfoW = esent.NewProc("JetGetAttachInfoW")
)

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

extern "esent" fn JetGetAttachInfoW(
    wszzDatabases: [*c]u16, // WORD* optional, out
    cbMax: u32, // DWORD
    pcbActual: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetAttachInfoW(
    wszzDatabases: ptr uint16,  # WORD* optional, out
    cbMax: uint32,  # DWORD
    pcbActual: ptr uint32  # DWORD* optional, out
): int32 {.importc: "JetGetAttachInfoW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetAttachInfoW(
    ushort* wszzDatabases,   // WORD* optional, out
    uint cbMax,   // DWORD
    uint* pcbActual   // DWORD* optional, out
);
ccall((:JetGetAttachInfoW, "ESENT.dll"), stdcall, Int32,
      (Ptr{UInt16}, UInt32, Ptr{UInt32}),
      wszzDatabases, cbMax, pcbActual)
# wszzDatabases : WORD* optional, out -> Ptr{UInt16}
# cbMax : DWORD -> UInt32
# pcbActual : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetAttachInfoW(
    uint16_t* wszzDatabases,
    uint32_t cbMax,
    uint32_t* pcbActual);
]]
local esent = ffi.load("esent")
-- esent.JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
-- wszzDatabases : WORD* optional, out
-- cbMax : DWORD
-- pcbActual : DWORD* optional, out
-- 構造体/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 JetGetAttachInfoW = lib.func('__stdcall', 'JetGetAttachInfoW', 'int32_t', ['uint16_t *', 'uint32_t', 'uint32_t *']);
// JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
// wszzDatabases : WORD* optional, out -> 'uint16_t *'
// cbMax : DWORD -> 'uint32_t'
// pcbActual : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetAttachInfoW: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual)
// wszzDatabases : WORD* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// pcbActual : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetAttachInfoW(
    uint16_t* wszzDatabases,
    uint32_t cbMax,
    uint32_t* pcbActual);
C, "ESENT.dll");
// $ffi->JetGetAttachInfoW(wszzDatabases, cbMax, pcbActual);
// wszzDatabases : WORD* 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, W32APIOptions.UNICODE_OPTIONS);
    int JetGetAttachInfoW(
        ShortByReference wszzDatabases,   // WORD* optional, out
        int cbMax,   // DWORD
        IntByReference pcbActual   // DWORD* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetAttachInfoW = JetGetAttachInfoW(
    wszzDatabases : UInt16*,   # WORD* 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 JetGetAttachInfoWNative = Int32 Function(Pointer<Uint16>, Uint32, Pointer<Uint32>);
typedef JetGetAttachInfoWDart = int Function(Pointer<Uint16>, int, Pointer<Uint32>);
final JetGetAttachInfoW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetAttachInfoWNative, JetGetAttachInfoWDart>('JetGetAttachInfoW');
// wszzDatabases : WORD* optional, out -> Pointer<Uint16>
// cbMax : DWORD -> Uint32
// pcbActual : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetAttachInfoW(
  wszzDatabases: Pointer;   // WORD* optional, out
  cbMax: DWORD;   // DWORD
  pcbActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetAttachInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetAttachInfoW"
  c_JetGetAttachInfoW :: Ptr Word16 -> Word32 -> Ptr Word32 -> IO Int32
-- wszzDatabases : WORD* optional, out -> Ptr Word16
-- cbMax : DWORD -> Word32
-- pcbActual : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetattachinfow =
  foreign "JetGetAttachInfoW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* wszzDatabases : WORD* optional, out -> (ptr uint16_t) *)
(* 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 ("JetGetAttachInfoW" jet-get-attach-info-w :convention :stdcall) :int32
  (wszz-databases :pointer)   ; WORD* 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 $JetGetAttachInfoW = Win32::API::More->new('ESENT',
    'int JetGetAttachInfoW(LPVOID wszzDatabases, DWORD cbMax, LPVOID pcbActual)');
# my $ret = $JetGetAttachInfoW->Call($wszzDatabases, $cbMax, $pcbActual);
# wszzDatabases : WORD* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い