ホーム › NetworkManagement.NetworkDiagnosticsFramework › NdfRepairIncident

NdfRepairIncident

関数

診断で特定した問題に対する修復を実行する。

DLLNDFAPI.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT NdfRepairIncident(
    void* Handle,
    RepairInfoEx* RepairEx,
    DWORD dwWait
);

パラメーター

名前	型	方向	説明
Handle	void*	in	Network Diagnostics Framework のインシデントへのハンドル。このハンドルは、NdfDiagnoseIncident に渡したハンドルと一致している必要があります。
RepairEx	RepairInfoEx*	in	実行する修復の内容を示す構造体(NdfDiagnoseIncident から取得します)。これらの構造体に割り当てられたメモリは、後で解放する必要があります。解放方法の例については、Microsoft Windows Network Diagnostics のサンプルを参照してください。
dwWait	DWORD	in	診断ルーチンを終了するまでに待機する時間(ミリ秒単位)。タイムアウトが不要な場合は、このパラメーターに INFINITE を渡すことができます。

名前

型

方向

説明

Handle

void*

Network Diagnostics Framework のインシデントへのハンドル。このハンドルは、NdfDiagnoseIncident に渡したハンドルと一致している必要があります。

RepairEx

RepairInfoEx*

実行する修復の内容を示す構造体(NdfDiagnoseIncident から取得します)。

これらの構造体に割り当てられたメモリは、後で解放する必要があります。解放方法の例については、Microsoft Windows Network Diagnostics のサンプルを参照してください。

dwWait

DWORD

診断ルーチンを終了するまでに待機する時間(ミリ秒単位)。タイムアウトが不要な場合は、このパラメーターに INFINITE を渡すことができます。

戻り値の型: HRESULT

公式ドキュメント

ユーザーインターフェイスを表示せずにインシデントを修復します。

戻り値

戻り値には次のようなものがありますが、これらに限定されません。

戻り値	説明
S_OK	修復に成功しました。
NDF_E_VALIDATION	修復は正常に実行されましたが、NDF による検証では依然として接続の問題が検出されました。この値が返された場合は、NdfCloseIncident を呼び出してセッションを閉じ、診断を続行するために新しいセッションを作成する必要があります。
E_HANDLE	NDF インシデントのハンドルが無効です。
WAIT_TIMEOUT	dwWait で指定したタイムアウトを超える時間がかかったため、修復操作が終了しました。

修復を実行できなかった場合は、その他のエラーコードが返されます。その場合、クライアントは別の修復を指定して NdfRepairIncident を再度呼び出すことができます。

解説(Remarks)

NdfRepairIncident は、診断に NdfDiagnoseIncident を使用する場合にのみ呼び出せます。これは通常、ユーザーインターフェイスを表示しないシナリオや、標準的な Windows のエクスペリエンスを使用しないシナリオ(Media Center や組み込みアプリケーションなど)に該当します。NdfExecuteDiagnosis を使用する場合は、NdfRepairIncident を呼び出さないでください。

この API を使用する前に、アプリケーションは NdfCreateWebIncident などのインシデント作成関数を呼び出して、NDF の診断プロセスを開始する必要があります。次に、アプリケーションは NdfDiagnoseIncident を呼び出して問題を診断します。診断プロセスで修復候補が特定された場合、アプリケーションは NdfRepairIncident を呼び出して、ユーザーインターフェイスを表示せずに問題を修復できます。実行中の NdfRepairIncident の呼び出しをキャンセルしたい場合は、別のスレッドから NdfCancelIncident を呼び出すこともできます。最後に、アプリケーションは NdfCloseIncident を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT NdfRepairIncident(
    void* Handle,
    RepairInfoEx* RepairEx,
    DWORD dwWait
);

[DllImport("NDFAPI.dll", ExactSpelling = true)]
static extern int NdfRepairIncident(
    IntPtr Handle,   // void*
    IntPtr RepairEx,   // RepairInfoEx*
    uint dwWait   // DWORD
);

<DllImport("NDFAPI.dll", ExactSpelling:=True)>
Public Shared Function NdfRepairIncident(
    Handle As IntPtr,   ' void*
    RepairEx As IntPtr,   ' RepairInfoEx*
    dwWait As UInteger   ' DWORD
) As Integer
End Function

' Handle : void*
' RepairEx : RepairInfoEx*
' dwWait : DWORD
Declare PtrSafe Function NdfRepairIncident Lib "ndfapi" ( _
    ByVal Handle As LongPtr, _
    ByVal RepairEx As LongPtr, _
    ByVal dwWait As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NdfRepairIncident = ctypes.windll.ndfapi.NdfRepairIncident
NdfRepairIncident.restype = ctypes.c_int
NdfRepairIncident.argtypes = [
    ctypes.POINTER(None),  # Handle : void*
    ctypes.c_void_p,  # RepairEx : RepairInfoEx*
    wintypes.DWORD,  # dwWait : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NDFAPI.dll')
NdfRepairIncident = Fiddle::Function.new(
  lib['NdfRepairIncident'],
  [
    Fiddle::TYPE_VOIDP,  # Handle : void*
    Fiddle::TYPE_VOIDP,  # RepairEx : RepairInfoEx*
    -Fiddle::TYPE_INT,  # dwWait : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "ndfapi")]
extern "system" {
    fn NdfRepairIncident(
        Handle: *mut (),  // void*
        RepairEx: *mut RepairInfoEx,  // RepairInfoEx*
        dwWait: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NDFAPI.dll")]
public static extern int NdfRepairIncident(IntPtr Handle, IntPtr RepairEx, uint dwWait);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NDFAPI_NdfRepairIncident' -Namespace Win32 -PassThru
# $api::NdfRepairIncident(Handle, RepairEx, dwWait)

#uselib "NDFAPI.dll"
#func global NdfRepairIncident "NdfRepairIncident" sptr, sptr, sptr
; NdfRepairIncident Handle, varptr(RepairEx), dwWait   ; 戻り値は stat
; Handle : void* -> "sptr"
; RepairEx : RepairInfoEx* -> "sptr"
; dwWait : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NDFAPI.dll"
#cfunc global NdfRepairIncident "NdfRepairIncident" sptr, var, int
; res = NdfRepairIncident(Handle, RepairEx, dwWait)
; Handle : void* -> "sptr"
; RepairEx : RepairInfoEx* -> "var"
; dwWait : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NDFAPI.dll"
#cfunc global NdfRepairIncident "NdfRepairIncident" sptr, sptr, int
; res = NdfRepairIncident(Handle, varptr(RepairEx), dwWait)
; Handle : void* -> "sptr"
; RepairEx : RepairInfoEx* -> "sptr"
; dwWait : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。