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

JetRetrieveColumns

関数
現在のレコードから複数の列の値をまとめて取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetRetrieveColumns(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_RETRIEVECOLUMN* pretrievecolumn,   // optional
    DWORD cretrievecolumn
);

パラメーター

名前型方向説明
sesidJET_SESIDin複数列の一括取得を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin対象レコードを持つテーブルのカーソルハンドル。
pretrievecolumnJET_RETRIEVECOLUMN*inoutoptional取得する列の指定と結果を保持するJET_RETRIEVECOLUMN構造体配列のポインタ。
cretrievecolumnDWORDinpretrievecolumn配列の要素数を指定する値。

戻り値の型: INT

公式ドキュメント

JetRetrieveColumns 関数は、現在のレコードから複数の列の値を 1 回の操作で取得します。取得する列値のセットと、取得する各列値の出力バッファーを記述するために、JET_RETRIEVECOLUMN 構造体の配列を使用します。

戻り値

この関数は、次のいずれかのリターンコードを持つ JET_ERR データ型を返します。発生し得る ESE のエラーの詳細については、「Extensible Storage Engine Errors」および「Error Handling Parameters」を参照してください。

リターンコード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errBadItagSequence

無効な複数値列のシーケンス番号値が pretinfo->itagSequence に渡されました。複数値列の値のシーケンス番号として有効な値は 1 以上です。0 (ゼロ) はこの関数では有効ですが、JetRetrieveColumn では無効です。

JET_errBadColumnId

指定された列 ID が、列 ID として許される範囲外です。

JET_errClientRequestToStopJetService

JetStopService の呼び出しによって、このセッションに関連付けられたインスタンス上のすべての動作が停止しているため、操作を完了できません。

JET_errColumnNotFound

指定された columnid で示される列がテーブルに存在しません。

JET_errIndexTuplesCannotRetrieveFromIndex

部分文字列としてインデックス付けされた列は、通常、各インデックスエントリに列の一部しか含まれないため、インデックスから取得できません。

JET_errInvalidBufferSize

場合によっては、列値を少しでも返すために、列取得用のバッファーが十分なサイズである必要があります。たとえば、エスクロー更新可能な列は、呼び出し元セッションのトランザクションコンテキストに対して一貫性を保つように調整されますが、この調整には呼び出し元が提供するバッファーが必要です。バッファー領域が不足している場合は JET_errInvalidBufferSize が返され、列データは一切返されません。

JET_errInvalidgrbit

指定されたオプションが不明であるか、既知のビット設定の組み合わせとして不正です。

JET_errInvalidParameter

指定されたパラメーターのうち 1 つ以上が正しくありません。これは、retinfo.cbStruct が JET_RETINFO のサイズより小さい場合に発生することがあります。

JET_errInstanceUnavailable

このセッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。

Windows XP: このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errNoCurrentRecord

カーソルがレコード上に位置していません。これはさまざまな理由で発生します。たとえば、現在のインデックスの最後のレコードよりも後ろにカーソルが位置している場合に発生します。

JET_errNotInitialized

このセッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errRestoreInProgress

このセッションに関連付けられたインスタンスで復元操作が進行中のため、操作を完了できません。

JET_errSessionSharingViolation

同一のセッションを、同時に複数のスレッドで使用することはできません。

Windows XP: このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errTermInProgress

このセッションに関連付けられたインスタンスがシャットダウン中のため、操作を完了できません。

JET_wrnBufferTruncated

指定されたバッファーが列のサイズより小さいため、列値全体を取得できませんでした。

成功した場合、列データと列のサイズは、JET_RETRIEVECOLUMN 構造体の配列で指定された各バッファーに返されます。列データではなく複数値フィールドのインスタンス数を取得するために itagSequence に 0 (ゼロ) を設定した場合は、複数値列のインスタンス数が itagSequence フィールド自体に返されます。各 JET_RETRIEVECOLUMN 構造体には、取得した列に関する警告を格納する error フィールドがあります。列の値が NULL であった場合、エラーコードには JET_wrnColumnNull が設定されます。

失敗した場合、カーソル位置は変更されず、指定されたバッファーにデータはコピーされません。

解説

JetRetrieveColumns は、JetRetrieveColumn にはない機能を 1 つサポートしています。それは、複数値列のインスタンス数を取得する機能です。この機能の目的は、アプリケーションが列のすべての値を取得できるようにすることです。これは、まず列が持つ値の数を調べることで実現できます。次に、値ごとに 1 つずつ JET_RETRIEVECOLUMN 構造体を割り当てて JetRetrieveColumns を再度呼び出すことで、それぞれの長さを調べます。これは、pvData ポインターに NULL を、cbMax に 0 (ゼロ) を渡し、列の長さを cbActual で受け取ることで行えます。3 回目、すなわち最後の呼び出しでは、列値データ用に割り当てたメモリを指定します。

いずれかの列がバッファーの長さ不足によって切り捨てられた場合、この API は JET_wrnBufferTruncated を返します。ただし、その他のエラー、たとえば JET_wrnColumnNull は、JET_RETRIEVECOLUMN の error フィールドにのみ返されます。これは、アプリケーションがすべてのデータを取得できたことを確認したい場合が多く、JetRetrieveColumns からこのエラーを返すことでその判断が容易になるためです。

要件

要件 値

クライアント

Windows Vista、Windows XP、または Windows 2000 Professional が必要です。

サーバー

Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

JET_ERR
JET_SESID
JET_TABLEID
JET_RETRIEVECOLUMN
JetEnumerateColumns
JetRetrieveColumn
JetSetColumns

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

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

JetRetrieveColumns = ctypes.windll.esent.JetRetrieveColumns
JetRetrieveColumns.restype = ctypes.c_int
JetRetrieveColumns.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.c_void_p,  # pretrievecolumn : JET_RETRIEVECOLUMN* optional, in/out
    wintypes.DWORD,  # cretrievecolumn : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetRetrieveColumns = esent.NewProc("JetRetrieveColumns")
)

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

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

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

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

関連項目

使用する型