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

PdhSetCounterScaleFactor

関数
カウンター値に適用する倍率係数を設定する。
DLLpdh.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhSetCounterScaleFactor(
    PDH_HCOUNTER hCounter,
    INT lFactor
);

パラメーター

名前方向説明
hCounterPDH_HCOUNTERinoutスケール係数を適用するカウンターのハンドルです。 PdhAddCounter 関数がこのハンドルを返します。
lFactorINTin計算値を返す前に乗算する 10 のべき乗です。このパラメーターの最小値は PDH_MIN_SCALE (–7) で、この場合は実際の値に 10⁷ を乗算した値が返されます。最大値は PDH_MAX_SCALE (+7) で、この場合は実際の値に 10⁺⁷ を乗算した値が返されます。値が 0 の場合はスケールが 1 に設定され、実際の値がそのまま返されます。

戻り値の型: DWORD

公式ドキュメント

フォーマット済みのカウンター値を要求したときに、指定したカウンターの計算値に適用されるスケール係数を設定します。PDH_FMT_NOSCALE フラグが設定されている場合、このスケール係数は無視されます。

戻り値

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

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

戻り値 説明
PDH_INVALID_ARGUMENT
スケール値が範囲外です。
PDH_INVALID_HANDLE
カウンターハンドルが無効です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

PdhSetCounterScaleFactor = ctypes.windll.pdh.PdhSetCounterScaleFactor
PdhSetCounterScaleFactor.restype = wintypes.DWORD
PdhSetCounterScaleFactor.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER in/out
    ctypes.c_int,  # lFactor : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhSetCounterScaleFactor = pdh.NewProc("PdhSetCounterScaleFactor")
)

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

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

typedef PdhSetCounterScaleFactorNative = Uint32 Function(Pointer<Void>, Int32);
typedef PdhSetCounterScaleFactorDart = int Function(Pointer<Void>, int);
final PdhSetCounterScaleFactor = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhSetCounterScaleFactorNative, PdhSetCounterScaleFactorDart>('PdhSetCounterScaleFactor');
// hCounter : PDH_HCOUNTER in/out -> Pointer<Void>
// lFactor : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhSetCounterScaleFactor(
  hCounter: THandle;   // PDH_HCOUNTER in/out
  lFactor: Integer   // INT
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhSetCounterScaleFactor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhSetCounterScaleFactor"
  c_PdhSetCounterScaleFactor :: Ptr () -> Int32 -> IO Word32
-- hCounter : PDH_HCOUNTER in/out -> Ptr ()
-- lFactor : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pdhsetcounterscalefactor =
  foreign "PdhSetCounterScaleFactor"
    ((ptr void) @-> int32_t @-> returning uint32_t)
(* hCounter : PDH_HCOUNTER in/out -> (ptr void) *)
(* lFactor : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhSetCounterScaleFactor" pdh-set-counter-scale-factor :convention :stdcall) :uint32
  (h-counter :pointer)   ; PDH_HCOUNTER in/out
  (l-factor :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhSetCounterScaleFactor = Win32::API::More->new('pdh',
    'DWORD PdhSetCounterScaleFactor(HANDLE hCounter, int lFactor)');
# my $ret = $PdhSetCounterScaleFactor->Call($hCounter, $lFactor);
# hCounter : PDH_HCOUNTER in/out -> HANDLE
# lFactor : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目