Win32 API 日本語リファレンス
ホーム › System.Performance › PdhUpdateLogA

PdhUpdateLogA

関数
ログファイルにデータを書き込み更新する(ANSI版)。
DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhUpdateLogA(
    PDH_HLOG hLog,
    LPCSTR szUserString   // optional
);

パラメーター

名前型方向説明
hLogPDH_HLOGin更新する単一のログファイルのハンドル。 PdhOpenLog 関数がこのハンドルを返します。
szUserStringLPCSTRinoptionalデータレコードに追加する、ユーザー定義のコメントを格納した null 終端文字列。空文字列にすることはできません。

戻り値の型: DWORD

公式ドキュメント

現在のクエリのカウンターデータを収集し、そのデータをログファイルに書き込みます。(ANSI)

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。次の値が考えられます。

戻り値 説明
PDH_INVALID_HANDLE
 ログファイルのハンドルが無効です。
PDH_INVALID_ARGUMENT
 szUserString パラメーターに空文字列が渡されました。

解説(Remarks)

あるログファイルを別のログファイルから更新する場合、もう一方のログファイルのコメントは移行されません。

例

例については、 パフォーマンスデータをログファイルに書き込む を参照してください。

メモ

pdh.h ヘッダーは PdhUpdateLog をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則 を参照してください。

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

各言語での呼び出し定義

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhUpdateLogA(
    PDH_HLOG hLog,
    LPCSTR szUserString   // optional
);
[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhUpdateLogA(
    IntPtr hLog,   // PDH_HLOG
    [MarshalAs(UnmanagedType.LPStr)] string szUserString   // LPCSTR optional
);
<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhUpdateLogA(
    hLog As IntPtr,   ' PDH_HLOG
    <MarshalAs(UnmanagedType.LPStr)> szUserString As String   ' LPCSTR optional
) As UInteger
End Function
' hLog : PDH_HLOG
' szUserString : LPCSTR optional
Declare PtrSafe Function PdhUpdateLogA Lib "pdh" ( _
    ByVal hLog As LongPtr, _
    ByVal szUserString As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PdhUpdateLogA = ctypes.windll.pdh.PdhUpdateLogA
PdhUpdateLogA.restype = wintypes.DWORD
PdhUpdateLogA.argtypes = [
    wintypes.HANDLE,  # hLog : PDH_HLOG
    wintypes.LPCSTR,  # szUserString : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhUpdateLogA = Fiddle::Function.new(
  lib['PdhUpdateLogA'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : PDH_HLOG
    Fiddle::TYPE_VOIDP,  # szUserString : LPCSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "pdh")]
extern "system" {
    fn PdhUpdateLogA(
        hLog: *mut core::ffi::c_void,  // PDH_HLOG
        szUserString: *const u8  // LPCSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Ansi)]
public static extern uint PdhUpdateLogA(IntPtr hLog, [MarshalAs(UnmanagedType.LPStr)] string szUserString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhUpdateLogA' -Namespace Win32 -PassThru
# $api::PdhUpdateLogA(hLog, szUserString)
#uselib "pdh.dll"
#func global PdhUpdateLogA "PdhUpdateLogA" sptr, sptr
; PdhUpdateLogA hLog, szUserString   ; 戻り値は stat
; hLog : PDH_HLOG -> "sptr"
; szUserString : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "pdh.dll"
#cfunc global PdhUpdateLogA "PdhUpdateLogA" sptr, str
; res = PdhUpdateLogA(hLog, szUserString)
; hLog : PDH_HLOG -> "sptr"
; szUserString : LPCSTR optional -> "str"
; DWORD PdhUpdateLogA(PDH_HLOG hLog, LPCSTR szUserString)
#uselib "pdh.dll"
#cfunc global PdhUpdateLogA "PdhUpdateLogA" intptr, str
; res = PdhUpdateLogA(hLog, szUserString)
; hLog : PDH_HLOG -> "intptr"
; szUserString : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhUpdateLogA = pdh.NewProc("PdhUpdateLogA")
)

// hLog (PDH_HLOG), szUserString (LPCSTR optional)
r1, _, err := procPdhUpdateLogA.Call(
	uintptr(hLog),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szUserString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PdhUpdateLogA(
  hLog: THandle;   // PDH_HLOG
  szUserString: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhUpdateLogA';
result := DllCall("pdh\PdhUpdateLogA"
    , "Ptr", hLog   ; PDH_HLOG
    , "AStr", szUserString   ; LPCSTR optional
    , "UInt")   ; return: DWORD
●PdhUpdateLogA(hLog, szUserString) = DLL("pdh.dll", "dword PdhUpdateLogA(void*, char*)")
# 呼び出し: PdhUpdateLogA(hLog, szUserString)
# hLog : PDH_HLOG -> "void*"
# szUserString : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "pdh" fn PdhUpdateLogA(
    hLog: ?*anyopaque, // PDH_HLOG
    szUserString: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc PdhUpdateLogA(
    hLog: pointer,  # PDH_HLOG
    szUserString: cstring  # LPCSTR optional
): uint32 {.importc: "PdhUpdateLogA", stdcall, dynlib: "pdh.dll".}
pragma(lib, "pdh");
extern(Windows)
uint PdhUpdateLogA(
    void* hLog,   // PDH_HLOG
    const(char)* szUserString   // LPCSTR optional
);
ccall((:PdhUpdateLogA, "pdh.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring),
      hLog, szUserString)
# hLog : PDH_HLOG -> Ptr{Cvoid}
# szUserString : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhUpdateLogA(
    void* hLog,
    const char* szUserString);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhUpdateLogA(hLog, szUserString)
-- hLog : PDH_HLOG
-- szUserString : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhUpdateLogA = lib.func('__stdcall', 'PdhUpdateLogA', 'uint32_t', ['void *', 'str']);
// PdhUpdateLogA(hLog, szUserString)
// hLog : PDH_HLOG -> 'void *'
// szUserString : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhUpdateLogA: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.PdhUpdateLogA(hLog, szUserString)
// hLog : PDH_HLOG -> "pointer"
// szUserString : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhUpdateLogA(
    void* hLog,
    const char* szUserString);
C, "pdh.dll");
// $ffi->PdhUpdateLogA(hLog, szUserString);
// hLog : PDH_HLOG
// szUserString : LPCSTR optional
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    int PdhUpdateLogA(
        Pointer hLog,   // PDH_HLOG
        String szUserString   // LPCSTR optional
    );
}
@[Link("pdh")]
lib Libpdh
  fun PdhUpdateLogA = PdhUpdateLogA(
    hLog : Void*,   # PDH_HLOG
    szUserString : UInt8*   # LPCSTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PdhUpdateLogANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>);
typedef PdhUpdateLogADart = int Function(Pointer<Void>, Pointer<Utf8>);
final PdhUpdateLogA = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhUpdateLogANative, PdhUpdateLogADart>('PdhUpdateLogA');
// hLog : PDH_HLOG -> Pointer<Void>
// szUserString : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhUpdateLogA(
  hLog: THandle;   // PDH_HLOG
  szUserString: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhUpdateLogA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhUpdateLogA"
  c_PdhUpdateLogA :: Ptr () -> CString -> IO Word32
-- hLog : PDH_HLOG -> Ptr ()
-- szUserString : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pdhupdateloga =
  foreign "PdhUpdateLogA"
    ((ptr void) @-> string @-> returning uint32_t)
(* hLog : PDH_HLOG -> (ptr void) *)
(* szUserString : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhUpdateLogA" pdh-update-log-a :convention :stdcall) :uint32
  (h-log :pointer)   ; PDH_HLOG
  (sz-user-string :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhUpdateLogA = Win32::API::More->new('pdh',
    'DWORD PdhUpdateLogA(HANDLE hLog, LPCSTR szUserString)');
# my $ret = $PdhUpdateLogA->Call($hLog, $szUserString);
# hLog : PDH_HLOG -> HANDLE
# szUserString : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目