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

PdhSetDefaultRealTimeDataSource

関数
既定のリアルタイムデータソースを設定する。
DLLpdh.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhSetDefaultRealTimeDataSource(
    REAL_TIME_DATA_SOURCE_ID_FLAGS dwDataSourceId
);

パラメーター

名前方向説明
dwDataSourceIdREAL_TIME_DATA_SOURCE_ID_FLAGSin

パフォーマンスデータのソースです。このパラメーターには、次のいずれかの値を指定できます。

意味
DATA_SOURCE_REGISTRY
データソースはレジストリインターフェイスです。これが既定値です。
DATA_SOURCE_WBEM
データソースは WMI プロバイダーです。

戻り値の型: DWORD

公式ドキュメント

リアルタイムデータのソースを指定します。

戻り値

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

関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。次の値が返される可能性があります。

戻り値コード 説明
PDH_INVALID_ARGUMENT
パラメーターが無効です。

解説(Remarks)

この関数の説明で使用されている リアルタイム という用語は、その語の標準的な意味を指すものではありません。ここでは、ログファイルからではなく、現在の情報を提供するソース(たとえばレジストリや WMI プロバイダー)からパフォーマンスデータを収集することを表しています。

WMI からリアルタイムデータをクエリする場合は、PdhSetDefaultRealTimeDataSource を呼び出して既定のリアルタイムデータソースを設定する必要があります。この関数は、他のいずれの PDH API 関数を呼び出すよりも前に呼び出す必要があります。

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

各言語での呼び出し定義

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

DWORD PdhSetDefaultRealTimeDataSource(
    REAL_TIME_DATA_SOURCE_ID_FLAGS dwDataSourceId
);
[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhSetDefaultRealTimeDataSource(
    uint dwDataSourceId   // REAL_TIME_DATA_SOURCE_ID_FLAGS
);
<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhSetDefaultRealTimeDataSource(
    dwDataSourceId As UInteger   ' REAL_TIME_DATA_SOURCE_ID_FLAGS
) As UInteger
End Function
' dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS
Declare PtrSafe Function PdhSetDefaultRealTimeDataSource Lib "pdh" ( _
    ByVal dwDataSourceId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PdhSetDefaultRealTimeDataSource = ctypes.windll.pdh.PdhSetDefaultRealTimeDataSource
PdhSetDefaultRealTimeDataSource.restype = wintypes.DWORD
PdhSetDefaultRealTimeDataSource.argtypes = [
    wintypes.DWORD,  # dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhSetDefaultRealTimeDataSource = pdh.NewProc("PdhSetDefaultRealTimeDataSource")
)

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

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

typedef PdhSetDefaultRealTimeDataSourceNative = Uint32 Function(Uint32);
typedef PdhSetDefaultRealTimeDataSourceDart = int Function(int);
final PdhSetDefaultRealTimeDataSource = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhSetDefaultRealTimeDataSourceNative, PdhSetDefaultRealTimeDataSourceDart>('PdhSetDefaultRealTimeDataSource');
// dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhSetDefaultRealTimeDataSource(
  dwDataSourceId: DWORD   // REAL_TIME_DATA_SOURCE_ID_FLAGS
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhSetDefaultRealTimeDataSource';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhSetDefaultRealTimeDataSource"
  c_PdhSetDefaultRealTimeDataSource :: Word32 -> IO Word32
-- dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pdhsetdefaultrealtimedatasource =
  foreign "PdhSetDefaultRealTimeDataSource"
    (uint32_t @-> returning uint32_t)
(* dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhSetDefaultRealTimeDataSource" pdh-set-default-real-time-data-source :convention :stdcall) :uint32
  (dw-data-source-id :uint32))   ; REAL_TIME_DATA_SOURCE_ID_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhSetDefaultRealTimeDataSource = Win32::API::More->new('pdh',
    'DWORD PdhSetDefaultRealTimeDataSource(DWORD dwDataSourceId)');
# my $ret = $PdhSetDefaultRealTimeDataSource->Call($dwDataSourceId);
# dwDataSourceId : REAL_TIME_DATA_SOURCE_ID_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型