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

JetGetThreadStats

関数
現在のスレッドのESE性能統計情報を取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetGetThreadStats(
    void* pvResult,
    DWORD cbMax
);

パラメーター

名前型方向説明
pvResultvoid*out現スレッドのデータベース操作統計(JET_THREADSTATS)を受け取るバッファへのポインタ。
cbMaxDWORDinpvResultバッファのバイトサイズ。

戻り値の型: INT

公式ドキュメント

JetGetThreadStats 関数は、現在のスレッドに関するパフォーマンス情報をデータベースエンジンから取得します。複数回呼び出すことで、それらの呼び出しの間にこのスレッド上でデータベースエンジンが行った動作を反映した統計情報を収集できます。

戻り値

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

戻り値コード

説明

JET_errSuccess

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

JET_errBufferTooSmall

指定された出力バッファーが要求されたデータを格納するには小さすぎたため、操作は失敗しました。JetGetThreadStats 関数は、データベースエンジンがサポートする JET_THREADSTATS 構造体の最小のバージョンを格納するにも出力バッファーが小さすぎる場合に、このエラーを返します。

成功した場合、出力バッファーには現在のスレッドのデータベースエンジン統計情報を含む JET_THREADSTATS 構造体が格納されます。

失敗した場合、出力バッファーの状態は未定義です。

解説

この API を連続して 2 回呼び出して得られる情報は、現在のスレッド上で行われる他のデータベースエンジン操作のコストを算出するために使用することを意図しています。通常は、対象の操作の前後で統計情報を読み取り、その差分を求めることで、実行された操作の正味の回数を得ます。

たとえば、アプリケーションはまず JetGetThreadStats を呼び出して、現在のスレッドの統計情報の初期値を取得します。次に、cRow パラメーターに JET_MoveNext を指定して JetMove 関数を呼び出し、インデックス上の次のインデックスエントリに移動します。その後、再び JetGetThreadStats を呼び出して、そのスレッドの統計情報をもう一度読み取ります。そして、2 回目の読み取りの cPageReferenced カウンターから 1 回目の値を差し引きます。その結果が、JetMove 操作を実行するためにデータベースエンジンが参照したデータベースページの数になります。

各スレッドの統計情報は、そのスレッドが存続する間ずっと累積されます。データベースエンジンの DLL がホストプロセスからアンロードされると、統計情報はリセットされます。

JET_THREADSTATS 構造体は、将来、より多くの統計情報を格納するように拡張される可能性があります。新しい統計情報は構造体の末尾に追加され、出力バッファーのサイズを大きくすることで取得できます。追加の統計情報が存在するかどうかは、cbStruct の値が大きくなっていることから判断できます。

要件

要件 値

クライアント

Windows Vista が必要です。

サーバー

Windows Server 2008 が必要です。

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

JET_ERR
JET_THREADSTATS
JetMove

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

各言語での呼び出し定義

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

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

JetGetThreadStats = ctypes.windll.esent.JetGetThreadStats
JetGetThreadStats.restype = ctypes.c_int
JetGetThreadStats.argtypes = [
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbMax : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetThreadStats = Fiddle::Function.new(
  lib['JetGetThreadStats'],
  [
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetGetThreadStats(
        pvResult: *mut (),  // void* out
        cbMax: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetGetThreadStats(IntPtr pvResult, uint cbMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetThreadStats' -Namespace Win32 -PassThru
# $api::JetGetThreadStats(pvResult, cbMax)
#uselib "ESENT.dll"
#func global JetGetThreadStats "JetGetThreadStats" sptr, sptr
; JetGetThreadStats pvResult, cbMax   ; 戻り値は stat
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetGetThreadStats "JetGetThreadStats" sptr, int
; res = JetGetThreadStats(pvResult, cbMax)
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; INT JetGetThreadStats(void* pvResult, DWORD cbMax)
#uselib "ESENT.dll"
#cfunc global JetGetThreadStats "JetGetThreadStats" intptr, int
; res = JetGetThreadStats(pvResult, cbMax)
; pvResult : void* out -> "intptr"
; cbMax : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetThreadStats = esent.NewProc("JetGetThreadStats")
)

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

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

foreign import stdcall safe "JetGetThreadStats"
  c_JetGetThreadStats :: Ptr () -> Word32 -> IO Int32
-- pvResult : void* out -> Ptr ()
-- cbMax : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetthreadstats =
  foreign "JetGetThreadStats"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* pvResult : void* out -> (ptr void) *)
(* cbMax : 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 ("JetGetThreadStats" jet-get-thread-stats :convention :stdcall) :int32
  (pv-result :pointer)   ; void* out
  (cb-max :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetThreadStats = Win32::API::More->new('ESENT',
    'int JetGetThreadStats(LPVOID pvResult, DWORD cbMax)');
# my $ret = $JetGetThreadStats->Call($pvResult, $cbMax);
# pvResult : void* out -> LPVOID
# cbMax : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。