IConnectorFramework.GetConnectorState(Guid) Method

Definition

Gets connector state for the given connector.

public:
 Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorState GetConnectorState(Guid connectorId);
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException))]
[System.ServiceModel.FaultContract(typeof(System.TimeoutException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownServiceException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownChannelException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException))]
[System.ServiceModel.OperationContract]
public Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorState GetConnectorState (Guid connectorId);
abstract member GetConnectorState : Guid -> Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorState
Public Function GetConnectorState (connectorId As Guid) As ConnectorState

Parameters

connectorId
Guid

The connector id.

Returns

ConnectorState

The state of the connector.

Attributes

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 connector.

Applies to