A Sandcastle Documented Class Library

# IHealthService CheckHealth Method

Checks the health of the application.

Namespace: Dundas.BI.Services.Health
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    HealthCheckResult CheckHealth(
    	HealthCheckConfig config
    )

    Function CheckHealth (
    	config As HealthCheckConfig
    ) As HealthCheckResult

    HealthCheckResult^ CheckHealth(
    	HealthCheckConfig^ config
    )

    abstract CheckHealth :
            config : HealthCheckConfig -> HealthCheckResult

#### Parameters

config
  Type: Dundas.BI.Services.Health
  HealthCheckConfig
  The configuration for the health check operation.

#### Return Value

Type: HealthCheckResult
An object representing the results of the health check.
Exceptions

Exception | Condition
--- | ---
ArgumentNullException | config is .
NoPrivilegeException | The caller does not have system administration privileges.
InvalidSessionException | The caller context is not associated with a valid session.

See Also

#### Reference

IHealthService Interface
Dundas.BI.Services.Health Namespace