| 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:ndhelper.INetDiagHelper.LowHealth |
INetDiagHelper::LowHealth (ndhelper.h) |
Check whether the component being diagnosed is healthy. |
|
ndf\inetdiaghelpe_lowhealth.htm |
NDF |
623de90f-c2dc-4879-9baf-4051d2d3691c |
12/05/2018 |
INetDiagHelper interface [NDF],LowHealth method, INetDiagHelper.LowHealth, INetDiagHelper::LowHealth, LowHealth, LowHealth method [NDF], LowHealth method [NDF],INetDiagHelper interface, ndf.inetdiaghelpe_lowhealth, ndhelper/INetDiagHelper::LowHealth |
ndhelper.h |
Windows |
Windows Vista [desktop apps only] |
Windows Server 2008 [desktop apps only] |
Windows |
19H1 |
|
|
|
|
|
|
The LowHealth method enables the Helper Class Extension to check whether the component being diagnosed is healthy.
A pointer to a null-terminated string containing the user-friendly description of the information being diagnosed. For example, if a class were to diagnosis a connectivity issue with an IP address, the pwszInstanceDescription parameter would contain the host name.
A pointer to a null-terminated string containing the description of the issue found if the component is found to be unhealthy.
A pointer to the time, in seconds, to be deferred if the diagnosis cannot be started immediately. This is used when the pStatus parameter is set to DS_DEFERRED.
A pointer to the DIAGNOSIS_STATUS that is returned from the diagnosis.
| Return code | Description |
|---|---|
|
The operation succeeded. |
|
There is not enough memory available to complete this operation. |
|
One or more parameters has not been provided correctly. |
|
The caller does not have sufficient privileges to perform the diagnosis or repair operation. |
|
The diagnosis or repair operation has been canceled. |
Helper Class Extensions may return HRESULTS that are specific to the failures encountered in the function.
The LowHealth method is required when building a Helper Class Extension.
If LowHealth returns DS_CONFIRMED, ppwszDescription will also contain a user-friendly description of the diagnosis result. The out parameter pDeferredTime contains the number of seconds this diagnosis needs to be deferred if pStatus returns DS_DEFERRED.
When LowHealth is confirmed, it may also optionally generate hypotheses in the GetLowerHypotheses method for other helper classes if the problem may be caused by other components. If not confirmed, NDF may further diagnose the problem by calling HighUtilization.
LowHealth may also return DS_INDETERMINATE if it is unable to diagnose the problem, but cannot confirm that the component is healthy. In this case, NDF will treat it as DS_CONFIRMED if none of the other hypotheses are confirmed.