ReplicationServer.EnumCurrentPrincipals Method

Returns information for all published databases that are participating in database mirroring.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Function EnumCurrentPrincipals As DataSet
'Usage
Dim instance As ReplicationServer
Dim returnValue As DataSet

returnValue = instance.EnumCurrentPrincipals()
public DataSet EnumCurrentPrincipals()
public:
DataSet^ EnumCurrentPrincipals()
member EnumCurrentPrincipals : unit -> DataSet 
public function EnumCurrentPrincipals() : DataSet

Return Value

Type: System.Data.DataSet
A DataSet object that contains the following columns.

Column

Data type

Description

db_name

sysname

Database name.

current_principal

sysname

The current principal for the mirrored database.

mirroring_role

tinyint

Current role of the local database plays in the database mirroring session.

1 = Principal

2 = Mirror

NULL = Database is not online.

mirroring_state

tinyint

State of the mirror database and of the database mirroring session.

0 = Suspended

1 = Disconnected

2 = Synchronizing

3 = Pending Failover

4 = Synchronized

NULL = Database is not online.

Remarks

This method is used to support replication with database mirroring. For more information, see Replication and Database Mirroring.