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

PdhValidatePathW

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

シグネチャ

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

DWORD PdhValidatePathW(
    LPCWSTR szFullPathBuffer
);

パラメーター

名前方向説明
szFullPathBufferLPCWSTRin検証するカウンターパスを含む、null で終端された文字列です。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。

戻り値の型: DWORD

公式ドキュメント

指定したカウンターパスのコンピューター上に、そのカウンターが存在することを検証します。(Unicode)

戻り値

関数が成功した場合は、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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PdhValidatePath を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不整合が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhValidatePathW(
    LPCWSTR szFullPathBuffer
);
[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhValidatePathW(
    [MarshalAs(UnmanagedType.LPWStr)] string szFullPathBuffer   // LPCWSTR
);
<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhValidatePathW(
    <MarshalAs(UnmanagedType.LPWStr)> szFullPathBuffer As String   ' LPCWSTR
) As UInteger
End Function
' szFullPathBuffer : LPCWSTR
Declare PtrSafe Function PdhValidatePathW Lib "pdh" ( _
    ByVal szFullPathBuffer 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

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

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhValidatePathW = pdh.NewProc("PdhValidatePathW")
)

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

extern "pdh" fn PdhValidatePathW(
    szFullPathBuffer: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PdhValidatePathW(
    szFullPathBuffer: WideCString  # LPCWSTR
): uint32 {.importc: "PdhValidatePathW", stdcall, dynlib: "pdh.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "pdh");
extern(Windows)
uint PdhValidatePathW(
    const(wchar)* szFullPathBuffer   // LPCWSTR
);
ccall((:PdhValidatePathW, "pdh.dll"), stdcall, UInt32,
      (Cwstring,),
      szFullPathBuffer)
# szFullPathBuffer : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhValidatePathW(
    const uint16_t* szFullPathBuffer);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhValidatePathW(szFullPathBuffer)
-- szFullPathBuffer : LPCWSTR
-- 構造体/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 PdhValidatePathW = lib.func('__stdcall', 'PdhValidatePathW', 'uint32_t', ['str16']);
// PdhValidatePathW(szFullPathBuffer)
// szFullPathBuffer : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhValidatePathW: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.PdhValidatePathW(szFullPathBuffer)
// szFullPathBuffer : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhValidatePathW(
    const uint16_t* szFullPathBuffer);
C, "pdh.dll");
// $ffi->PdhValidatePathW(szFullPathBuffer);
// szFullPathBuffer : LPCWSTR
// 構造体/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 PdhValidatePathW(
        WString szFullPathBuffer   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("pdh")]
lib Libpdh
  fun PdhValidatePathW = PdhValidatePathW(
    szFullPathBuffer : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

関連項目

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