ホーム › System.Performance › PdhUpdateLogFileCatalog
PdhUpdateLogFileCatalog
関数ログファイルのカタログ情報を更新する。
シグネチャ
// pdh.dll
#include <windows.h>
DWORD PdhUpdateLogFileCatalog(
PDH_HLOG hLog
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLog | PDH_HLOG | in | 更新対象のファイルカタログを含むログファイルへのハンドル。 PdhOpenLog 関数。 |
戻り値の型: DWORD
公式ドキュメント
ログファイルカタログの情報を、ログファイル内のパフォーマンスデータと同期します。
戻り値
関数が成功した場合は、ERROR_SUCCESS を返します。
関数が失敗した場合、戻り値は システムエラーコードまたは PDH エラーコードです。以下は想定される値です。
| 戻り値 | 説明 |
|---|---|
| CSV または TSV ログファイルへのハンドルが指定されました。これらの種類のログファイルにはカタログがありません。 | |
| 不明な形式のログファイルへのハンドルが指定されました。 | |
| ハンドルが無効です。 |
解説(Remarks)
ログファイルカタログは、ログファイル内のパフォーマンスデータレコードに対するインデックスとして機能し、ファイル内の個々のレコードをより高速に検索できるようにします。
カタログは、データ収集処理が完了し、ログファイルが閉じられた後に更新してください。データ収集中にカタログを更新することもできますが、カタログの更新には時間がかかる場合があるため、パフォーマンスデータの記録処理を妨げるおそれがあります。
Perfmon、CSV、TSV ログファイルにはカタログがありません。これらの種類のログファイルへのハンドルを指定すると、戻り値は PDH_NOT_IMPLEMENTED になります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// pdh.dll
#include <windows.h>
DWORD PdhUpdateLogFileCatalog(
PDH_HLOG hLog
);[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhUpdateLogFileCatalog(
IntPtr hLog // PDH_HLOG
);<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhUpdateLogFileCatalog(
hLog As IntPtr ' PDH_HLOG
) As UInteger
End Function' hLog : PDH_HLOG
Declare PtrSafe Function PdhUpdateLogFileCatalog Lib "pdh" ( _
ByVal hLog As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PdhUpdateLogFileCatalog = ctypes.windll.pdh.PdhUpdateLogFileCatalog
PdhUpdateLogFileCatalog.restype = wintypes.DWORD
PdhUpdateLogFileCatalog.argtypes = [
wintypes.HANDLE, # hLog : PDH_HLOG
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('pdh.dll')
PdhUpdateLogFileCatalog = Fiddle::Function.new(
lib['PdhUpdateLogFileCatalog'],
[
Fiddle::TYPE_VOIDP, # hLog : PDH_HLOG
],
-Fiddle::TYPE_INT)#[link(name = "pdh")]
extern "system" {
fn PdhUpdateLogFileCatalog(
hLog: *mut core::ffi::c_void // PDH_HLOG
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhUpdateLogFileCatalog(IntPtr hLog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhUpdateLogFileCatalog' -Namespace Win32 -PassThru
# $api::PdhUpdateLogFileCatalog(hLog)#uselib "pdh.dll"
#func global PdhUpdateLogFileCatalog "PdhUpdateLogFileCatalog" sptr
; PdhUpdateLogFileCatalog hLog ; 戻り値は stat
; hLog : PDH_HLOG -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "pdh.dll"
#cfunc global PdhUpdateLogFileCatalog "PdhUpdateLogFileCatalog" sptr
; res = PdhUpdateLogFileCatalog(hLog)
; hLog : PDH_HLOG -> "sptr"; DWORD PdhUpdateLogFileCatalog(PDH_HLOG hLog)
#uselib "pdh.dll"
#cfunc global PdhUpdateLogFileCatalog "PdhUpdateLogFileCatalog" intptr
; res = PdhUpdateLogFileCatalog(hLog)
; hLog : PDH_HLOG -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
pdh = windows.NewLazySystemDLL("pdh.dll")
procPdhUpdateLogFileCatalog = pdh.NewProc("PdhUpdateLogFileCatalog")
)
// hLog (PDH_HLOG)
r1, _, err := procPdhUpdateLogFileCatalog.Call(
uintptr(hLog),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction PdhUpdateLogFileCatalog(
hLog: THandle // PDH_HLOG
): DWORD; stdcall;
external 'pdh.dll' name 'PdhUpdateLogFileCatalog';result := DllCall("pdh\PdhUpdateLogFileCatalog"
, "Ptr", hLog ; PDH_HLOG
, "UInt") ; return: DWORD●PdhUpdateLogFileCatalog(hLog) = DLL("pdh.dll", "dword PdhUpdateLogFileCatalog(void*)")
# 呼び出し: PdhUpdateLogFileCatalog(hLog)
# hLog : PDH_HLOG -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "pdh" fn PdhUpdateLogFileCatalog(
hLog: ?*anyopaque // PDH_HLOG
) callconv(std.os.windows.WINAPI) u32;proc PdhUpdateLogFileCatalog(
hLog: pointer # PDH_HLOG
): uint32 {.importc: "PdhUpdateLogFileCatalog", stdcall, dynlib: "pdh.dll".}pragma(lib, "pdh");
extern(Windows)
uint PdhUpdateLogFileCatalog(
void* hLog // PDH_HLOG
);ccall((:PdhUpdateLogFileCatalog, "pdh.dll"), stdcall, UInt32,
(Ptr{Cvoid},),
hLog)
# hLog : PDH_HLOG -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhUpdateLogFileCatalog(
void* hLog);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhUpdateLogFileCatalog(hLog)
-- hLog : PDH_HLOG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhUpdateLogFileCatalog = lib.func('__stdcall', 'PdhUpdateLogFileCatalog', 'uint32_t', ['void *']);
// PdhUpdateLogFileCatalog(hLog)
// hLog : PDH_HLOG -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("pdh.dll", {
PdhUpdateLogFileCatalog: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.PdhUpdateLogFileCatalog(hLog)
// hLog : PDH_HLOG -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhUpdateLogFileCatalog(
void* hLog);
C, "pdh.dll");
// $ffi->PdhUpdateLogFileCatalog(hLog);
// hLog : PDH_HLOG
// 構造体/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 Pdh extends StdCallLibrary {
Pdh INSTANCE = Native.load("pdh", Pdh.class);
int PdhUpdateLogFileCatalog(
Pointer hLog // PDH_HLOG
);
}@[Link("pdh")]
lib Libpdh
fun PdhUpdateLogFileCatalog = PdhUpdateLogFileCatalog(
hLog : Void* # PDH_HLOG
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PdhUpdateLogFileCatalogNative = Uint32 Function(Pointer<Void>);
typedef PdhUpdateLogFileCatalogDart = int Function(Pointer<Void>);
final PdhUpdateLogFileCatalog = DynamicLibrary.open('pdh.dll')
.lookupFunction<PdhUpdateLogFileCatalogNative, PdhUpdateLogFileCatalogDart>('PdhUpdateLogFileCatalog');
// hLog : PDH_HLOG -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PdhUpdateLogFileCatalog(
hLog: THandle // PDH_HLOG
): DWORD; stdcall;
external 'pdh.dll' name 'PdhUpdateLogFileCatalog';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PdhUpdateLogFileCatalog"
c_PdhUpdateLogFileCatalog :: Ptr () -> IO Word32
-- hLog : PDH_HLOG -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pdhupdatelogfilecatalog =
foreign "PdhUpdateLogFileCatalog"
((ptr void) @-> returning uint32_t)
(* hLog : PDH_HLOG -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)
(cffi:defcfun ("PdhUpdateLogFileCatalog" pdh-update-log-file-catalog :convention :stdcall) :uint32
(h-log :pointer)) ; PDH_HLOG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PdhUpdateLogFileCatalog = Win32::API::More->new('pdh',
'DWORD PdhUpdateLogFileCatalog(HANDLE hLog)');
# my $ret = $PdhUpdateLogFileCatalog->Call($hLog);
# hLog : PDH_HLOG -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f PdhGetLogFileSize — ログファイルの現在のサイズを取得する。
- f PdhUpdateLogW — ログファイルにカウンターデータを書き込み更新する。