Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 2.87 KB

nf-ndfapi-ndfcancelincident.md

File metadata and controls

97 lines (78 loc) · 2.87 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ndfapi.NdfCancelIncident
NdfCancelIncident function (ndfapi.h)
Used to cancel unneeded functions which have been previously called on an existing incident.
NdfCancelIncident
NdfCancelIncident function [NDF]
ndf.ndfcancelincident
ndfapi/NdfCancelIncident
ndf\ndfcancelincident.htm
NDF
dc0cbfc0-fcaa-44b2-a753-8df9f184b8ca
12/05/2018
NdfCancelIncident, NdfCancelIncident function [NDF], ndf.ndfcancelincident, ndfapi/NdfCancelIncident
ndfapi.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Ndfapi.lib
Ndfapi.dll
Windows
19H1
NdfCancelIncident
ndfapi/NdfCancelIncident
c++
APIRef
kbSyntax
DllExport
Ndfapi.dll
NdfCancelIncident

NdfCancelIncident function

-description

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

-parameters

-param Handle [in]

Type: NDFHANDLE

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

-returns

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.