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

NdfDiagnoseIncident

関数
診断インシデントを解析し根本原因の一覧を取得する。
DLLNDFAPI.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT NdfDiagnoseIncident(
    void* Handle,
    DWORD* RootCauseCount,
    RootCauseInfo** RootCauses,
    DWORD dwWait,
    DWORD dwFlags
);

パラメーター

名前方向説明
Handlevoid*in診断対象インシデントのハンドルを指定する。
RootCauseCountDWORD*out検出された根本原因の数を受け取る出力ポインター。
RootCausesRootCauseInfo**out根本原因情報RootCauseInfo配列へのポインターを受け取る。使用後解放する。
dwWaitDWORDin診断完了を待機するタイムアウト時間(ミリ秒)を指定する。
dwFlagsDWORDin診断動作を制御するフラグを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

NdfDiagnoseIncident = ctypes.windll.ndfapi.NdfDiagnoseIncident
NdfDiagnoseIncident.restype = ctypes.c_int
NdfDiagnoseIncident.argtypes = [
    ctypes.POINTER(None),  # Handle : void*
    ctypes.POINTER(wintypes.DWORD),  # RootCauseCount : DWORD* out
    ctypes.c_void_p,  # RootCauses : RootCauseInfo** out
    wintypes.DWORD,  # dwWait : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ndfapi = windows.NewLazySystemDLL("NDFAPI.dll")
	procNdfDiagnoseIncident = ndfapi.NewProc("NdfDiagnoseIncident")
)

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

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

typedef NdfDiagnoseIncidentNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Uint32, Uint32);
typedef NdfDiagnoseIncidentDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, int, int);
final NdfDiagnoseIncident = DynamicLibrary.open('NDFAPI.dll')
    .lookupFunction<NdfDiagnoseIncidentNative, NdfDiagnoseIncidentDart>('NdfDiagnoseIncident');
// Handle : void* -> Pointer<Void>
// RootCauseCount : DWORD* out -> Pointer<Uint32>
// RootCauses : RootCauseInfo** out -> Pointer<Void>
// dwWait : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NdfDiagnoseIncident(
  Handle: Pointer;   // void*
  RootCauseCount: Pointer;   // DWORD* out
  RootCauses: Pointer;   // RootCauseInfo** out
  dwWait: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'NDFAPI.dll' name 'NdfDiagnoseIncident';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NdfDiagnoseIncident"
  c_NdfDiagnoseIncident :: Ptr () -> Ptr Word32 -> Ptr () -> Word32 -> Word32 -> IO Int32
-- Handle : void* -> Ptr ()
-- RootCauseCount : DWORD* out -> Ptr Word32
-- RootCauses : RootCauseInfo** out -> Ptr ()
-- dwWait : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ndfdiagnoseincident =
  foreign "NdfDiagnoseIncident"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* Handle : void* -> (ptr void) *)
(* RootCauseCount : DWORD* out -> (ptr uint32_t) *)
(* RootCauses : RootCauseInfo** out -> (ptr void) *)
(* dwWait : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ndfapi (t "NDFAPI.dll"))
(cffi:use-foreign-library ndfapi)

(cffi:defcfun ("NdfDiagnoseIncident" ndf-diagnose-incident :convention :stdcall) :int32
  (handle :pointer)   ; void*
  (root-cause-count :pointer)   ; DWORD* out
  (root-causes :pointer)   ; RootCauseInfo** out
  (dw-wait :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NdfDiagnoseIncident = Win32::API::More->new('NDFAPI',
    'int NdfDiagnoseIncident(LPVOID Handle, LPVOID RootCauseCount, LPVOID RootCauses, DWORD dwWait, DWORD dwFlags)');
# my $ret = $NdfDiagnoseIncident->Call($Handle, $RootCauseCount, $RootCauses, $dwWait, $dwFlags);
# Handle : void* -> LPVOID
# RootCauseCount : DWORD* out -> LPVOID
# RootCauses : RootCauseInfo** out -> LPVOID
# dwWait : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型