Share via

IWebGateway.QueryWebGatewayStatus Method

  • Article

Gets the status of the Web Gateway Provider.

Namespace: Microsoft.HomeServer.Extensibility
Assembly: HomeServerExt (in homeserverext.dll)

Usage

Syntax

'Declaration
Function QueryWebGatewayStatus ( _
    refresh As Boolean _
) As WebStatus

WebStatus QueryWebGatewayStatus (
    bool refresh
)

WebStatus QueryWebGatewayStatus (
    bool refresh
)

WebStatus QueryWebGatewayStatus (
    boolean refresh
)

function QueryWebGatewayStatus (
    refresh : boolean
) : WebStatus

Parameters

  • refresh
    A bool value that indicates whether the Web Gateway Provider should return a refreshed status.

Return Value

An enumeration of type WebStatus that indicates the status of the Web Gateway Provider.

Example

public WebStatus QueryWebGatewayStatus(bool refresh)
  {
    if (!refresh)
       return WebGatewayStatus;
    {
      // Do some work here to get the new status          
      return WebGatewayStatus;
    }
  }

Remarks

There are 3 possible states that the QueryWebGatewayStatus method can return:

Broken

Unknown

Working

If QueryWebGatewayStatus is called with the refresh argument set to false, the method should return quickly and may return a cached result.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP

Target Platforms

Windows Home Server

See Also

Reference

IWebGateway Interface
IWebGateway Members
Microsoft.HomeServer.Extensibility Namespace