ホーム › System.Performance › PdhUpdateLogW
PdhUpdateLogW
関数ログファイルにカウンターデータを書き込み更新する。
シグネチャ
// pdh.dll (Unicode / -W)
#include <windows.h>
DWORD PdhUpdateLogW(
PDH_HLOG hLog,
LPCWSTR szUserString // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLog | PDH_HLOG | in | 更新する単一のログファイルのハンドル。このハンドルは PdhOpenLog 関数から返されます。 |
| szUserString | LPCWSTR | inoptional | データレコードに追加するユーザー定義のコメントを格納した、NULL 終端文字列。この文字列を空にすることはできません。 |
戻り値の型: DWORD
公式ドキュメント
現在のクエリのカウンターデータを収集し、そのデータをログファイルに書き込みます。(Unicode)
戻り値
関数が成功した場合は ERROR_SUCCESS を返します。
関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。次の値が返される可能性があります。
| 戻り値 | 説明 |
|---|---|
| ログファイルハンドルが有効ではありません。 | |
| szUserString パラメーターに空の文字列が渡されました。 |
解説(Remarks)
あるログファイルから別のログファイルを更新する場合、元のログファイルのコメントは移行されません。
例
例については、 Writing Performance Data to a Log File を参照してください。
メモ
pdh.h ヘッダーは PdhUpdateLog を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (Unicode / -W)
#include <windows.h>
DWORD PdhUpdateLogW(
PDH_HLOG hLog,
LPCWSTR szUserString // optional
);[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhUpdateLogW(
IntPtr hLog, // PDH_HLOG
[MarshalAs(UnmanagedType.LPWStr)] string szUserString // LPCWSTR optional
);<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhUpdateLogW(
hLog As IntPtr, ' PDH_HLOG
<MarshalAs(UnmanagedType.LPWStr)> szUserString As String ' LPCWSTR optional
) As UInteger
End Function' hLog : PDH_HLOG
' szUserString : LPCWSTR optional
Declare PtrSafe Function PdhUpdateLogW Lib "pdh" ( _
ByVal hLog As LongPtr, _
ByVal szUserString As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PdhUpdateLogW = ctypes.windll.pdh.PdhUpdateLogW
PdhUpdateLogW.restype = wintypes.DWORD
PdhUpdateLogW.argtypes = [
wintypes.HANDLE, # hLog : PDH_HLOG
wintypes.LPCWSTR, # szUserString : LPCWSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('pdh.dll')
PdhUpdateLogW = Fiddle::Function.new(
lib['PdhUpdateLogW'],
[
Fiddle::TYPE_VOIDP, # hLog : PDH_HLOG
Fiddle::TYPE_VOIDP, # szUserString : LPCWSTR optional
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "pdh")]
extern "system" {
fn PdhUpdateLogW(
hLog: *mut core::ffi::c_void, // PDH_HLOG
szUserString: *const u16 // LPCWSTR optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhUpdateLogW(IntPtr hLog, [MarshalAs(UnmanagedType.LPWStr)] string szUserString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhUpdateLogW' -Namespace Win32 -PassThru
# $api::PdhUpdateLogW(hLog, szUserString)#uselib "pdh.dll"
#func global PdhUpdateLogW "PdhUpdateLogW" wptr, wptr
; PdhUpdateLogW hLog, szUserString ; 戻り値は stat
; hLog : PDH_HLOG -> "wptr"
; szUserString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "pdh.dll"
#cfunc global PdhUpdateLogW "PdhUpdateLogW" sptr, wstr
; res = PdhUpdateLogW(hLog, szUserString)
; hLog : PDH_HLOG -> "sptr"
; szUserString : LPCWSTR optional -> "wstr"; DWORD PdhUpdateLogW(PDH_HLOG hLog, LPCWSTR szUserString)
#uselib "pdh.dll"
#cfunc global PdhUpdateLogW "PdhUpdateLogW" intptr, wstr
; res = PdhUpdateLogW(hLog, szUserString)
; hLog : PDH_HLOG -> "intptr"
; szUserString : LPCWSTR optional -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
pdh = windows.NewLazySystemDLL("pdh.dll")
procPdhUpdateLogW = pdh.NewProc("PdhUpdateLogW")
)
// hLog (PDH_HLOG), szUserString (LPCWSTR optional)
r1, _, err := procPdhUpdateLogW.Call(
uintptr(hLog),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szUserString))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction PdhUpdateLogW(
hLog: THandle; // PDH_HLOG
szUserString: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'pdh.dll' name 'PdhUpdateLogW';result := DllCall("pdh\PdhUpdateLogW"
, "Ptr", hLog ; PDH_HLOG
, "WStr", szUserString ; LPCWSTR optional
, "UInt") ; return: DWORD●PdhUpdateLogW(hLog, szUserString) = DLL("pdh.dll", "dword PdhUpdateLogW(void*, char*)")
# 呼び出し: PdhUpdateLogW(hLog, szUserString)
# hLog : PDH_HLOG -> "void*"
# szUserString : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "pdh" fn PdhUpdateLogW(
hLog: ?*anyopaque, // PDH_HLOG
szUserString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc PdhUpdateLogW(
hLog: pointer, # PDH_HLOG
szUserString: WideCString # LPCWSTR optional
): uint32 {.importc: "PdhUpdateLogW", stdcall, dynlib: "pdh.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "pdh");
extern(Windows)
uint PdhUpdateLogW(
void* hLog, // PDH_HLOG
const(wchar)* szUserString // LPCWSTR optional
);ccall((:PdhUpdateLogW, "pdh.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Cwstring),
hLog, szUserString)
# hLog : PDH_HLOG -> Ptr{Cvoid}
# szUserString : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhUpdateLogW(
void* hLog,
const uint16_t* szUserString);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhUpdateLogW(hLog, szUserString)
-- hLog : PDH_HLOG
-- szUserString : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhUpdateLogW = lib.func('__stdcall', 'PdhUpdateLogW', 'uint32_t', ['void *', 'str16']);
// PdhUpdateLogW(hLog, szUserString)
// hLog : PDH_HLOG -> 'void *'
// szUserString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("pdh.dll", {
PdhUpdateLogW: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.PdhUpdateLogW(hLog, szUserString)
// hLog : PDH_HLOG -> "pointer"
// szUserString : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhUpdateLogW(
void* hLog,
const uint16_t* szUserString);
C, "pdh.dll");
// $ffi->PdhUpdateLogW(hLog, szUserString);
// hLog : PDH_HLOG
// szUserString : LPCWSTR 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.UNICODE_OPTIONS);
int PdhUpdateLogW(
Pointer hLog, // PDH_HLOG
WString szUserString // LPCWSTR optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("pdh")]
lib Libpdh
fun PdhUpdateLogW = PdhUpdateLogW(
hLog : Void*, # PDH_HLOG
szUserString : UInt16* # LPCWSTR optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PdhUpdateLogWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>);
typedef PdhUpdateLogWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final PdhUpdateLogW = DynamicLibrary.open('pdh.dll')
.lookupFunction<PdhUpdateLogWNative, PdhUpdateLogWDart>('PdhUpdateLogW');
// hLog : PDH_HLOG -> Pointer<Void>
// szUserString : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PdhUpdateLogW(
hLog: THandle; // PDH_HLOG
szUserString: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'pdh.dll' name 'PdhUpdateLogW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PdhUpdateLogW"
c_PdhUpdateLogW :: Ptr () -> CWString -> IO Word32
-- hLog : PDH_HLOG -> Ptr ()
-- szUserString : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pdhupdatelogw =
foreign "PdhUpdateLogW"
((ptr void) @-> (ptr uint16_t) @-> returning uint32_t)
(* hLog : PDH_HLOG -> (ptr void) *)
(* szUserString : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)
(cffi:defcfun ("PdhUpdateLogW" pdh-update-log-w :convention :stdcall) :uint32
(h-log :pointer) ; PDH_HLOG
(sz-user-string (:string :encoding :utf-16le))) ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PdhUpdateLogW = Win32::API::More->new('pdh',
'DWORD PdhUpdateLogW(HANDLE hLog, LPCWSTR szUserString)');
# my $ret = $PdhUpdateLogW->Call($hLog, $szUserString);
# hLog : PDH_HLOG -> HANDLE
# szUserString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f PdhUpdateLogA (ANSI版) — ログファイルにデータを書き込み更新する(ANSI版)。
公式の関連項目
- f PdhGetLogFileSize — ログファイルの現在のサイズを取得する。
- f PdhOpenLogW — パフォーマンスデータのログファイルを開く。
- f PdhOpenQueryW — 新しいパフォーマンスデータ照会を作成して開く。
- f PdhUpdateLogFileCatalog — ログファイルのカタログ情報を更新する。