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

JetIndexRecordCount

関数
現在のインデックス範囲内のレコード数を数える。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetIndexRecordCount(
    JET_SESID sesid,
    JET_TABLEID tableid,
    DWORD* pcrec,
    DWORD crecMax
);

パラメーター

名前型方向説明
sesidJET_SESIDinレコード数計数を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin計数対象のテーブルカーソルハンドル。現在のインデックス範囲内が対象となる。
pcrecDWORD*out計数されたレコード数を受け取る出力ポインタ。
crecMaxDWORDin計数する最大レコード数。0で全件を数える上限なしとなる。

戻り値の型: INT

公式ドキュメント

JetIndexRecordCount 関数は、現在のインデックスにおいて、現在の位置から前方にあるエントリの数を数えます。現在の位置もカウントに含まれます。現在のインデックスが多値列に対するものであり、その列のインスタンスが複数の値を持つ場合、カウントはテーブル内のレコードの総数より大きくなることがあります。テーブルが空の場合は、カウントとして 0 が返されます。

戻り値

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

リターンコード

説明

JET_errSuccess

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

JET_errClientRequestToStopJetService

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

JET_errInstanceUnavailable

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

Windows XP: このリターン値は Windows XP で導入されました。

JET_errNoCurrentRecord

カーソルが現在レコード上に位置しておらず、かつテーブルが空ではありません。

Windows XP、Windows Server 2003、Windows 2000 Server、および Windows 2000 Professional: カーソルが空のインデックスまたはインデックス範囲に位置している場合、JetIndexRecordCount は誤って JET_errNoCurrentRecord を返します。

JET_errNotInitialized

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

JET_errRestoreInProgress

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

JET_errSessionSharingViolation

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

Windows XP: このリターン値は Windows XP で導入されました。

JET_errTermInProgress

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

この関数が成功した場合、現在の位置を含み crecMax (0 でない場合) までの正確なインデックスエントリ数が、pcrec が指す unsigned long に返されます。

この関数が失敗した場合、precpos に割り当てられたメモリーに変更は加えられません。

解説

テーブルが空でない場合は、カウントを開始するレコードにカーソルを位置付けておく必要があります。カウントにはこのレコードが含まれ、crecMax で指定された上限まで前方に数えます。crecMax が 0 の場合、操作はインデックスの末尾に達するまでカウントを続けます。

インデックス範囲を使用すると、カウントのために人為的なインデックスの終端を設けることができます。この方法により、インデックスの部分範囲を正確に数えられます。カーソルは範囲の先頭行に位置付ける必要があります。範囲の終端キーを作成し、JetSetIndexRange を使用して上限を包含的または排他的に設定します。最後に JetIndexRecordCount を呼び出して、その範囲を正確に数えます。

JetIndexRecordCount はトランザクションのセマンティクスに従い、この特定のセッションの現在のトランザクション状態において正確なカウントを返します。

JetIndexRecordCount は、エントリを正確に数えるためにインデックスのリーフページにアクセスします。そのため、大量の I/O が発生し、処理が遅くなる可能性があります。過度の負荷を避けるには、crecMax による制限を使用してください。範囲が大きい場合は、JetGetRecordPosition を使用して、その範囲を概算で数えられることがあります。

Windows XP、Windows Server 2003、Windows 2000 Server、および Windows 2000 Professional: カーソルが空のインデックスまたはインデックス範囲に位置している場合、JetIndexRecordCount はレコード数として 0 を返さずに、誤って JET_errNoCurrentRecord を返します。この場合、アプリケーションはインデックスまたはインデックス範囲が空かどうかを確認する必要があります。

要件

要件 値

クライアント

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
JetGetRecordPosition
JetSetIndexRange
JetStopService

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

各言語での呼び出し定義

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

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

JetIndexRecordCount = ctypes.windll.esent.JetIndexRecordCount
JetIndexRecordCount.restype = ctypes.c_int
JetIndexRecordCount.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(wintypes.DWORD),  # pcrec : DWORD* out
    wintypes.DWORD,  # crecMax : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetIndexRecordCount = esent.NewProc("JetIndexRecordCount")
)

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

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

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

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