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

PdhValidatePathA

関数
カウンターパスが有効か検証する(ANSI版)。
DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhValidatePathA(
    LPCSTR szFullPathBuffer
);

パラメーター

名前方向説明
szFullPathBufferLPCSTRin検証するカウンターパスを格納した null 終端文字列。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。

戻り値の型: DWORD

公式ドキュメント

カウンターパスで指定されたコンピューター上にカウンターが存在することを検証します。(ANSI)

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

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

戻り値 説明
PDH_CSTATUS_NO_INSTANCE
指定されたパフォーマンスオブジェクトのインスタンスが見つかりませんでした。
PDH_CSTATUS_NO_COUNTER
指定されたカウンターがパフォーマンスオブジェクト内に見つかりませんでした。
PDH_CSTATUS_NO_OBJECT
指定されたパフォーマンスオブジェクトがコンピューター上に見つかりませんでした。
PDH_CSTATUS_NO_MACHINE
指定されたコンピューターが見つからないか、接続できませんでした。
PDH_CSTATUS_BAD_COUNTERNAME
カウンターパス文字列を解析できませんでした。
PDH_MEMORY_ALLOCATION_FAILURE
関数が必要な一時バッファーを割り当てられませんでした。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhValidatePathA(
    LPCSTR szFullPathBuffer
);
[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhValidatePathA(
    [MarshalAs(UnmanagedType.LPStr)] string szFullPathBuffer   // LPCSTR
);
<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhValidatePathA(
    <MarshalAs(UnmanagedType.LPStr)> szFullPathBuffer As String   ' LPCSTR
) As UInteger
End Function
' szFullPathBuffer : LPCSTR
Declare PtrSafe Function PdhValidatePathA Lib "pdh" ( _
    ByVal szFullPathBuffer As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhValidatePathA = pdh.NewProc("PdhValidatePathA")
)

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

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

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

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

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

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

関連項目

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