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

PdhConnectMachineW

関数
リモートマシンへ接続しデータ収集を有効にする。
DLLpdh.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhConnectMachineW(
    LPCWSTR szMachineName   // optional
);

パラメーター

名前型方向説明
szMachineNameLPCWSTRinoptional接続先のコンピューター名を指定する Null で終わる文字列です。NULL の場合、PDH はローカルコンピューターに接続します。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューターに接続します。(Unicode)

戻り値

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

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

戻り値 説明
PDH_CSTATUS_NO_MACHINE
 指定したコンピューターに接続できません。コンピューターが起動していない、PDH をサポートしていない、ネットワークに接続されていない、またはユーザーによるリモート接続やリモートパフォーマンス監視を妨げる権限がレジストリに設定されていることが原因として考えられます。
PDH_MEMORY_ALLOCATION_FAILURE
 動的メモリブロックを割り当てられません。システム上で多数のアプリケーションが実行されている、またはメモリページングファイルが不足していることによる深刻なメモリ不足がシステムで発生した場合に起こります。

解説(Remarks)

通常、アプリケーションはこの関数を呼び出さず、アプリケーションがカウンターをクエリに追加したときに接続が確立されます。

ただし、Browse Counters ダイアログボックスの Select counters from computer 一覧にローカルコンピューター以外を含めたい場合は、この関数を使用できます。詳細については、PDH_BROWSE_DLG_CONFIG 構造体を参照してください。

メモ

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

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

各言語での呼び出し定義

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhConnectMachineW(
    LPCWSTR szMachineName   // optional
);
[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhConnectMachineW(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName   // LPCWSTR optional
);
<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhConnectMachineW(
    <MarshalAs(UnmanagedType.LPWStr)> szMachineName As String   ' LPCWSTR optional
) As UInteger
End Function
' szMachineName : LPCWSTR optional
Declare PtrSafe Function PdhConnectMachineW Lib "pdh" ( _
    ByVal szMachineName 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

PdhConnectMachineW = ctypes.windll.pdh.PdhConnectMachineW
PdhConnectMachineW.restype = wintypes.DWORD
PdhConnectMachineW.argtypes = [
    wintypes.LPCWSTR,  # szMachineName : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhConnectMachineW = Fiddle::Function.new(
  lib['PdhConnectMachineW'],
  [
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "pdh")]
extern "system" {
    fn PdhConnectMachineW(
        szMachineName: *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 PdhConnectMachineW([MarshalAs(UnmanagedType.LPWStr)] string szMachineName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhConnectMachineW' -Namespace Win32 -PassThru
# $api::PdhConnectMachineW(szMachineName)
#uselib "pdh.dll"
#func global PdhConnectMachineW "PdhConnectMachineW" wptr
; PdhConnectMachineW szMachineName   ; 戻り値は stat
; szMachineName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "pdh.dll"
#cfunc global PdhConnectMachineW "PdhConnectMachineW" wstr
; res = PdhConnectMachineW(szMachineName)
; szMachineName : LPCWSTR optional -> "wstr"
; DWORD PdhConnectMachineW(LPCWSTR szMachineName)
#uselib "pdh.dll"
#cfunc global PdhConnectMachineW "PdhConnectMachineW" wstr
; res = PdhConnectMachineW(szMachineName)
; szMachineName : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhConnectMachineW = pdh.NewProc("PdhConnectMachineW")
)

// szMachineName (LPCWSTR optional)
r1, _, err := procPdhConnectMachineW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szMachineName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PdhConnectMachineW(
  szMachineName: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhConnectMachineW';
result := DllCall("pdh\PdhConnectMachineW"
    , "WStr", szMachineName   ; LPCWSTR optional
    , "UInt")   ; return: DWORD
●PdhConnectMachineW(szMachineName) = DLL("pdh.dll", "dword PdhConnectMachineW(char*)")
# 呼び出し: PdhConnectMachineW(szMachineName)
# szMachineName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "pdh" fn PdhConnectMachineW(
    szMachineName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PdhConnectMachineW(
    szMachineName: WideCString  # LPCWSTR optional
): uint32 {.importc: "PdhConnectMachineW", stdcall, dynlib: "pdh.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "pdh");
extern(Windows)
uint PdhConnectMachineW(
    const(wchar)* szMachineName   // LPCWSTR optional
);
ccall((:PdhConnectMachineW, "pdh.dll"), stdcall, UInt32,
      (Cwstring,),
      szMachineName)
# szMachineName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhConnectMachineW(
    const uint16_t* szMachineName);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhConnectMachineW(szMachineName)
-- szMachineName : 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 PdhConnectMachineW = lib.func('__stdcall', 'PdhConnectMachineW', 'uint32_t', ['str16']);
// PdhConnectMachineW(szMachineName)
// szMachineName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhConnectMachineW: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.PdhConnectMachineW(szMachineName)
// szMachineName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhConnectMachineW(
    const uint16_t* szMachineName);
C, "pdh.dll");
// $ffi->PdhConnectMachineW(szMachineName);
// szMachineName : 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 PdhConnectMachineW(
        WString szMachineName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("pdh")]
lib Libpdh
  fun PdhConnectMachineW = PdhConnectMachineW(
    szMachineName : 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 PdhConnectMachineWNative = Uint32 Function(Pointer<Utf16>);
typedef PdhConnectMachineWDart = int Function(Pointer<Utf16>);
final PdhConnectMachineW = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhConnectMachineWNative, PdhConnectMachineWDart>('PdhConnectMachineW');
// szMachineName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhConnectMachineW(
  szMachineName: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhConnectMachineW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let pdhconnectmachinew =
  foreign "PdhConnectMachineW"
    ((ptr uint16_t) @-> returning uint32_t)
(* szMachineName : 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 ("PdhConnectMachineW" pdh-connect-machine-w :convention :stdcall) :uint32
  (sz-machine-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhConnectMachineW = Win32::API::More->new('pdh',
    'DWORD PdhConnectMachineW(LPCWSTR szMachineName)');
# my $ret = $PdhConnectMachineW->Call($szMachineName);
# szMachineName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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