Share via

ConnectorFrameworkProxy.GetConnectorState Method

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Gets the state of the specified monitoring connector.

Namespace: Microsoft.EnterpriseManagement.ConnectorFramework
Assembly: Microsoft.EnterpriseManagement.OperationsManager (in Microsoft.EnterpriseManagement.OperationsManager.dll)

Usage

'Usage
Dim instance As ConnectorFrameworkProxy
Dim connectorId As Guid
Dim returnValue As ConnectorState

returnValue = instance.GetConnectorState(connectorId)

Syntax

'Declaration
Public Function GetConnectorState ( _
    connectorId As Guid _
) As ConnectorState

public ConnectorState GetConnectorState (
    Guid connectorId
)

public:
ConnectorState GetConnectorState (
    Guid connectorId
)

public ConnectorState GetConnectorState (
    Guid connectorId
)

public function GetConnectorState (
    connectorId : Guid
) : ConnectorState

Parameters

  • connectorId
    The globally unique identifier (GUID) of the monitoring connector for which the state information is returned.

Return Value

Returns a ConnectorState enumeration that describes the monitoring connector's state.

Remarks

The returned value indicates if the monitoring connector is initialized or uninitialized.

The GetConnectorState method is used to check the initialization state of the monitoring connector. The monitoring connector must be set up and initialized before any alerts can be retrieved. Attempting to initialize a monitoring connector that is already initialized results in an exception with the "The connector is already in the given state." warning. It is advisable to perform a check of the ConnectorState to determine if the monitoring connector is already initialized before attempting to Initialize the monitoring connector.

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 Vista, Windows Server 2003, and

Target Platforms

See Also

Reference

ConnectorFrameworkProxy Class
ConnectorFrameworkProxy Members
Microsoft.EnterpriseManagement.ConnectorFramework Namespace