Edit

NdfCancelIncident function (ndfapi.h)

  • Article

The NdfCancelIncident function is used to cancel unneeded functions which have been previously called on an existing incident.

Syntax

void NdfCancelIncident(
  [in] NDFHANDLE Handle
);

Parameters

[in] Handle

Type: NDFHANDLE

Handle to the Network Diagnostics Framework incident. This handle should match the handle of an existing incident.

Return value

Type: HRESULT

Possible return values include, but are not limited to, the following.

Return code Description
S_OK
 The operation succeeded.
 

Any result other than S_OK should be interpreted as an error.

Remarks

Before using this API, an application must call an incident creation function such as NdfCreateWebIncident.

NdfCancelIncident is primarily used to cancel calls to functions such as NdfDiagnoseIncident or NdfRepairIncident which have been previously called, but are no longer needed. When NdfCancelIncident is called, NDF will stop the diagnosis/repair as soon as possible rather than calling the other functions (unless results have already been returned from those functions, in which case NdfCancelIncident will have no effect).

NdfCloseIncident should be used to close an incident once it has been resolved, as NdfCancelIncident does not actually close the incident itself.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header ndfapi.h
Library Ndfapi.lib
DLL Ndfapi.dll