Edit

Share via

INetDiagHelper::HighUtilization method (ndhelper.h)

  • Article

The HighUtilization method enables the Helper Class Extension to check whether the corresponding component is highly utilized.

Syntax

HRESULT HighUtilization(
  [in]  LPCWSTR          pwszInstanceDescription,
  [out] LPWSTR           *ppwszDescription,
  [out] long             *pDeferredTime,
  [out] DIAGNOSIS_STATUS *pStatus
);

Parameters

[in] pwszInstanceDescription

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.

[out] ppwszDescription

A pointer to a null-terminated string containing the description of high utilization diagnosis result.

[out] pDeferredTime

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.

[out] pStatus

A pointer to the DIAGNOSIS_STATUS that is returned from the diagnosis.

Return value

Return code Description
S_OK
 The operation succeeded.
E_OUTOFMEMORY
 There is not enough memory available to complete this operation.
E_INVALIDARG
 One or more parameters has not been provided correctly.
E_NOTIMPL
 This optional method is not implemented.
E_ACCESSDENIED
 The caller does not have sufficient privileges to perform the diagnosis or repair operation.
E_ABORT
 The diagnosis or repair operation has been canceled.
 

Helper Class Extensions may return HRESULTS that are specific to the failures encountered in the function.

Remarks

This method is not required when building a Helper Class Extension.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header ndhelper.h

See also

INetDiagHelper