ホーム › System.Diagnostics.Etw › TRACE_PERIODIC_CAPTURE_STATE_INFO

TRACE_PERIODIC_CAPTURE_STATE_INFO

構造体

サイズx64: 8 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
CaptureStateFrequencyInSeconds	DWORD	4	+0	+0	状態キャプチャの頻度 (秒単位)。
ProviderCount	WORD	2	+4	+4	プロバイダーの数。
Reserved	WORD	2	+6	+6	将来の使用のために予約済みです。

公式ドキュメント

TraceQueryInformation および TraceSetInformation と共に使用して、定期的な状態キャプチャに関する情報を取得または設定します。

解説(Remarks)

定期的な状態キャプチャは、状態キャプチャ通知をプロバイダーへ定期的に送信できるようにする仕組みです。これを有効にすると、通知は現在のセッションに対して事前に有効化されているプロバイダー登録に対してのみ送信されます。各プロバイダーは、通知に対する独自の応答を定義できます (応答しない場合もあります)。なお、通知に応答してプロバイダーがログに記録したイベントは、手動で要求した状態キャプチャと同様に、そのプロバイダーが有効化されているすべての ETW セッションに送信されます。

定期的な状態キャプチャを使用するには、次の手順に従います。

TRACE_PERIODIC_CAPTURE_STATE_INFO 型のバッファーを割り当てます。バッファーのサイズは sizeof(TRACE_PERIODIC_CAPTURE_STATE_INFO) + (x * sizeof(GUID)) とします。ここで x は有効にするプロバイダーの数です。
TRACE_INFO_CLASS 列挙型の TracePeriodicCaptureStateInfo を指定して TraceQueryInformation を呼び出します。バッファーとそのサイズを TraceQueryInformation の TraceInformation パラメーターおよび InformationLength パラメーターとして渡します。
TRACE_PERIODIC_CAPTURE_STATE_INFO の CaptureStateFrequencyInSeconds に、使用している Windows のバージョンでサポートされる最小の頻度を設定します。この値は将来変更される可能性があるため、ハードコーディングは推奨されません。頻度が最小値を下回る場合、 TraceSetInformation の呼び出しは失敗します。
TRACE_PERIODIC_CAPTURE_STATE_INFO の ProviderCount に、渡すプロバイダー GUID の数を設定します。
TRACE_PERIODIC_CAPTURE_STATE_INFO 構造体の末尾に続けて、各プロバイダーの GUID を追加します。ここでは、最初の手順で追加的に割り当てた (x * sizeof(GUID)) の領域を使用します。
TRACE_INFO_CLASS 列挙型の TracePeriodicCaptureStateListInfo を指定して TraceSetInformation を呼び出します。
定期的な状態キャプチャを無効にするには、 TRACE_INFO_CLASS の TracePeriodicCaptureStateListInfo、TraceInformation に NULL、InformationLength に 0 を指定して、TraceSetInformation を再度呼び出します。

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

各言語での定義

#include <windows.h>

// TRACE_PERIODIC_CAPTURE_STATE_INFO  (x64 8 / x86 8 バイト)
typedef struct TRACE_PERIODIC_CAPTURE_STATE_INFO {
    DWORD CaptureStateFrequencyInSeconds;
    WORD ProviderCount;
    WORD Reserved;
} TRACE_PERIODIC_CAPTURE_STATE_INFO;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TRACE_PERIODIC_CAPTURE_STATE_INFO
{
    public uint CaptureStateFrequencyInSeconds;
    public ushort ProviderCount;
    public ushort Reserved;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TRACE_PERIODIC_CAPTURE_STATE_INFO
    Public CaptureStateFrequencyInSeconds As UInteger
    Public ProviderCount As UShort
    Public Reserved As UShort
End Structure

import ctypes
from ctypes import wintypes

class TRACE_PERIODIC_CAPTURE_STATE_INFO(ctypes.Structure):
    _fields_ = [
        ("CaptureStateFrequencyInSeconds", wintypes.DWORD),
        ("ProviderCount", ctypes.c_ushort),
        ("Reserved", ctypes.c_ushort),
    ]

#[repr(C)]
pub struct TRACE_PERIODIC_CAPTURE_STATE_INFO {
    pub CaptureStateFrequencyInSeconds: u32,
    pub ProviderCount: u16,
    pub Reserved: u16,
}

import "golang.org/x/sys/windows"

type TRACE_PERIODIC_CAPTURE_STATE_INFO struct {
	CaptureStateFrequencyInSeconds uint32
	ProviderCount uint16
	Reserved uint16
}

type
  TRACE_PERIODIC_CAPTURE_STATE_INFO = record
    CaptureStateFrequencyInSeconds: DWORD;
    ProviderCount: Word;
    Reserved: Word;
  end;

const TRACE_PERIODIC_CAPTURE_STATE_INFO = extern struct {
    CaptureStateFrequencyInSeconds: u32,
    ProviderCount: u16,
    Reserved: u16,
};

type
  TRACE_PERIODIC_CAPTURE_STATE_INFO {.bycopy.} = object
    CaptureStateFrequencyInSeconds: uint32
    ProviderCount: uint16
    Reserved: uint16

struct TRACE_PERIODIC_CAPTURE_STATE_INFO
{
    uint CaptureStateFrequencyInSeconds;
    ushort ProviderCount;
    ushort Reserved;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TRACE_PERIODIC_CAPTURE_STATE_INFO サイズ: 8 バイト(x64)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; CaptureStateFrequencyInSeconds : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; ProviderCount : WORD (+4, 2byte)  wpoke st,4,値  /  値 = wpeek(st,4)
; Reserved : WORD (+6, 2byte)  wpoke st,6,値  /  値 = wpeek(st,6)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TRACE_PERIODIC_CAPTURE_STATE_INFO
    #field int CaptureStateFrequencyInSeconds
    #field short ProviderCount
    #field short Reserved
#endstruct

stdim st, TRACE_PERIODIC_CAPTURE_STATE_INFO        ; NSTRUCT 変数を確保
st->CaptureStateFrequencyInSeconds = 100
mes "CaptureStateFrequencyInSeconds=" + st->CaptureStateFrequencyInSeconds