ホーム › 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
);

パラメーター

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

戻り値の型: 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 方式にも切替可。#uselib "NDFAPI.dll"
#cfunc global NdfDiagnoseIncident "NdfDiagnoseIncident" sptr, sptr, sptr, int, int
; res = NdfDiagnoseIncident(Handle, varptr(RootCauseCount), varptr(RootCauses), dwWait, dwFlags)
; Handle : void* -> "sptr"
; RootCauseCount : DWORD* out -> "sptr"
; RootCauses : RootCauseInfo** out -> "sptr"
; dwWait : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; HRESULT NdfDiagnoseIncident(void* Handle, DWORD* RootCauseCount, RootCauseInfo** RootCauses, DWORD dwWait, DWORD dwFlags)
#uselib "NDFAPI.dll"
#cfunc global NdfDiagnoseIncident "NdfDiagnoseIncident" intptr, intptr, intptr, int, int
; res = NdfDiagnoseIncident(Handle, varptr(RootCauseCount), varptr(RootCauses), dwWait, dwFlags)
; Handle : void* -> "intptr"
; RootCauseCount : DWORD* out -> "intptr"
; RootCauses : RootCauseInfo** out -> "intptr"
; dwWait : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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)。