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

PdhConnectMachineA

関数
リモートマシンへ接続する(ANSI版)。
DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhConnectMachineA(
    LPCSTR szMachineName   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合は 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  (ANSI / -A)
#include <windows.h>

DWORD PdhConnectMachineA(
    LPCSTR szMachineName   // optional
);
[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhConnectMachineA(
    [MarshalAs(UnmanagedType.LPStr)] string szMachineName   // LPCSTR optional
);
<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhConnectMachineA(
    <MarshalAs(UnmanagedType.LPStr)> szMachineName As String   ' LPCSTR optional
) As UInteger
End Function
' szMachineName : LPCSTR optional
Declare PtrSafe Function PdhConnectMachineA Lib "pdh" ( _
    ByVal szMachineName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhConnectMachineA = pdh.NewProc("PdhConnectMachineA")
)

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

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

typedef PdhConnectMachineANative = Uint32 Function(Pointer<Utf8>);
typedef PdhConnectMachineADart = int Function(Pointer<Utf8>);
final PdhConnectMachineA = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhConnectMachineANative, PdhConnectMachineADart>('PdhConnectMachineA');
// szMachineName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhConnectMachineA(
  szMachineName: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhConnectMachineA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("PdhConnectMachineA" pdh-connect-machine-a :convention :stdcall) :uint32
  (sz-machine-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhConnectMachineA = Win32::API::More->new('pdh',
    'DWORD PdhConnectMachineA(LPCSTR szMachineName)');
# my $ret = $PdhConnectMachineA->Call($szMachineName);
# szMachineName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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