Share via

IConnectorFramework.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 IConnectorFramework
Dim connectorId As Guid
Dim returnValue As ConnectorState

returnValue = instance.GetConnectorState(connectorId)

Syntax

'Declaration
<FaultContractAttribute(GetType(ConnectorInvalidException))> _
<FaultContractAttribute(GetType(ServerDisconnectedException))> _
<FaultContractAttribute(GetType(ServiceNotRunningException))> _
<OperationContractAttribute> _
<FaultContractAttribute(GetType(TimeoutException))> _
<FaultContractAttribute(GetType(UnknownServiceException))> _
<FaultContractAttribute(GetType(UnknownChannelException))> _
<FaultContractAttribute(GetType(UnauthorizedAccessEnterpriseManagementException))> _
<FaultContractAttribute(GetType(UnknownAuthorizationStoreException))> _
<FaultContractAttribute(GetType(UnknownDatabaseException))> _
<FaultContractAttribute(GetType(InvalidDatabaseDataException))> _
Function GetConnectorState ( _
    connectorId As Guid _
) As ConnectorState

[FaultContractAttribute(typeof(ConnectorInvalidException))] 
[FaultContractAttribute(typeof(ServerDisconnectedException))] 
[FaultContractAttribute(typeof(ServiceNotRunningException))] 
[OperationContractAttribute] 
[FaultContractAttribute(typeof(TimeoutException))] 
[FaultContractAttribute(typeof(UnknownServiceException))] 
[FaultContractAttribute(typeof(UnknownChannelException))] 
[FaultContractAttribute(typeof(UnauthorizedAccessEnterpriseManagementException))] 
[FaultContractAttribute(typeof(UnknownAuthorizationStoreException))] 
[FaultContractAttribute(typeof(UnknownDatabaseException))] 
[FaultContractAttribute(typeof(InvalidDatabaseDataException))] 
ConnectorState GetConnectorState (
    Guid connectorId
)

[FaultContractAttribute(typeof(ConnectorInvalidException))] 
[FaultContractAttribute(typeof(ServerDisconnectedException))] 
[FaultContractAttribute(typeof(ServiceNotRunningException))] 
[OperationContractAttribute] 
[FaultContractAttribute(typeof(TimeoutException))] 
[FaultContractAttribute(typeof(UnknownServiceException))] 
[FaultContractAttribute(typeof(UnknownChannelException))] 
[FaultContractAttribute(typeof(UnauthorizedAccessEnterpriseManagementException))] 
[FaultContractAttribute(typeof(UnknownAuthorizationStoreException))] 
[FaultContractAttribute(typeof(UnknownDatabaseException))] 
[FaultContractAttribute(typeof(InvalidDatabaseDataException))] 
ConnectorState GetConnectorState (
    Guid connectorId
)

/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException) */ 
/** @attribute OperationContractAttribute() */ 
/** @attribute FaultContractAttribute(System.TimeoutException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownServiceException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownChannelException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException) */ 
ConnectorState GetConnectorState (
    Guid connectorId
)

FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException) 
OperationContractAttribute 
FaultContractAttribute(System.TimeoutException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownServiceException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownChannelException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException) 
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 connector's initialization 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 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

IConnectorFramework Interface
IConnectorFramework Members
Microsoft.EnterpriseManagement.ConnectorFramework Namespace