Win32 API 日本語リファレンス
ホームNetworkManagement.NetworkDiagnosticsFramework › NdfGetTraceFile

NdfGetTraceFile

関数
診断インシデントのトレースファイルの場所を取得する。
DLLNDFAPI.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT NdfGetTraceFile(
    void* Handle,
    LPCWSTR* TraceFileLocation
);

パラメーター

名前方向説明
Handlevoid*in対象診断インシデントのハンドルを指定する。
TraceFileLocationLPCWSTR*out生成されたトレースファイルのパスを受け取るポインター。使用後解放する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT NdfGetTraceFile(
    void* Handle,
    LPCWSTR* TraceFileLocation
);
[DllImport("NDFAPI.dll", ExactSpelling = true)]
static extern int NdfGetTraceFile(
    IntPtr Handle,   // void*
    IntPtr TraceFileLocation   // LPCWSTR* out
);
<DllImport("NDFAPI.dll", ExactSpelling:=True)>
Public Shared Function NdfGetTraceFile(
    Handle As IntPtr,   ' void*
    TraceFileLocation As IntPtr   ' LPCWSTR* out
) As Integer
End Function
' Handle : void*
' TraceFileLocation : LPCWSTR* out
Declare PtrSafe Function NdfGetTraceFile Lib "ndfapi" ( _
    ByVal Handle As LongPtr, _
    ByVal TraceFileLocation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NdfGetTraceFile = ctypes.windll.ndfapi.NdfGetTraceFile
NdfGetTraceFile.restype = ctypes.c_int
NdfGetTraceFile.argtypes = [
    ctypes.POINTER(None),  # Handle : void*
    ctypes.c_void_p,  # TraceFileLocation : LPCWSTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NDFAPI.dll')
NdfGetTraceFile = Fiddle::Function.new(
  lib['NdfGetTraceFile'],
  [
    Fiddle::TYPE_VOIDP,  # Handle : void*
    Fiddle::TYPE_VOIDP,  # TraceFileLocation : LPCWSTR* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ndfapi")]
extern "system" {
    fn NdfGetTraceFile(
        Handle: *mut (),  // void*
        TraceFileLocation: *const *const u16  // LPCWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NDFAPI.dll")]
public static extern int NdfGetTraceFile(IntPtr Handle, IntPtr TraceFileLocation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NDFAPI_NdfGetTraceFile' -Namespace Win32 -PassThru
# $api::NdfGetTraceFile(Handle, TraceFileLocation)
#uselib "NDFAPI.dll"
#func global NdfGetTraceFile "NdfGetTraceFile" sptr, sptr
; NdfGetTraceFile Handle, varptr(TraceFileLocation)   ; 戻り値は stat
; Handle : void* -> "sptr"
; TraceFileLocation : LPCWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NDFAPI.dll"
#cfunc global NdfGetTraceFile "NdfGetTraceFile" sptr, var
; res = NdfGetTraceFile(Handle, TraceFileLocation)
; Handle : void* -> "sptr"
; TraceFileLocation : LPCWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT NdfGetTraceFile(void* Handle, LPCWSTR* TraceFileLocation)
#uselib "NDFAPI.dll"
#cfunc global NdfGetTraceFile "NdfGetTraceFile" intptr, var
; res = NdfGetTraceFile(Handle, TraceFileLocation)
; Handle : void* -> "intptr"
; TraceFileLocation : LPCWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ndfapi = windows.NewLazySystemDLL("NDFAPI.dll")
	procNdfGetTraceFile = ndfapi.NewProc("NdfGetTraceFile")
)

// Handle (void*), TraceFileLocation (LPCWSTR* out)
r1, _, err := procNdfGetTraceFile.Call(
	uintptr(Handle),
	uintptr(TraceFileLocation),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function NdfGetTraceFile(
  Handle: Pointer;   // void*
  TraceFileLocation: PPWideChar   // LPCWSTR* out
): Integer; stdcall;
  external 'NDFAPI.dll' name 'NdfGetTraceFile';
result := DllCall("NDFAPI\NdfGetTraceFile"
    , "Ptr", Handle   ; void*
    , "Ptr", TraceFileLocation   ; LPCWSTR* out
    , "Int")   ; return: HRESULT
●NdfGetTraceFile(Handle, TraceFileLocation) = DLL("NDFAPI.dll", "int NdfGetTraceFile(void*, void*)")
# 呼び出し: NdfGetTraceFile(Handle, TraceFileLocation)
# Handle : void* -> "void*"
# TraceFileLocation : LPCWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef NdfGetTraceFileNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef NdfGetTraceFileDart = int Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
final NdfGetTraceFile = DynamicLibrary.open('NDFAPI.dll')
    .lookupFunction<NdfGetTraceFileNative, NdfGetTraceFileDart>('NdfGetTraceFile');
// Handle : void* -> Pointer<Void>
// TraceFileLocation : LPCWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NdfGetTraceFile(
  Handle: Pointer;   // void*
  TraceFileLocation: PPWideChar   // LPCWSTR* out
): Integer; stdcall;
  external 'NDFAPI.dll' name 'NdfGetTraceFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NdfGetTraceFile"
  c_NdfGetTraceFile :: Ptr () -> Ptr CWString -> IO Int32
-- Handle : void* -> Ptr ()
-- TraceFileLocation : LPCWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ndfgettracefile =
  foreign "NdfGetTraceFile"
    ((ptr void) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* Handle : void* -> (ptr void) *)
(* TraceFileLocation : LPCWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ndfapi (t "NDFAPI.dll"))
(cffi:use-foreign-library ndfapi)

(cffi:defcfun ("NdfGetTraceFile" ndf-get-trace-file :convention :stdcall) :int32
  (handle :pointer)   ; void*
  (trace-file-location :pointer))   ; LPCWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NdfGetTraceFile = Win32::API::More->new('NDFAPI',
    'int NdfGetTraceFile(LPVOID Handle, LPVOID TraceFileLocation)');
# my $ret = $NdfGetTraceFile->Call($Handle, $TraceFileLocation);
# Handle : void* -> LPVOID
# TraceFileLocation : LPCWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。