ReadReplicationFailOverMode Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The ReadReplicationFailOverMode method retrieves the failover mode for a subscription that uses immediate updating with queued updating as the failover option.
Syntax
object
.ReadReplicationFailOverMode(
szPublisher,
szPublicationDB,
szPublication )asSQLDMO_REPLFAILOVER_TYPE
Parts
object
Expression that evaluates to an object in the Applies To list.szPublisher
String that specifies the name of the Publisher.szPublicationDB
String that specifies the name of the publication database.szPublication
String that specifies the name of the publication.
Settings
ReadReplicationFailOverMode returns these values.
Constant |
Value |
Description |
|---|---|---|
SQLDMOReplFailOver_/Immediate |
0 |
Use the immediate updating option to propagate changes made at Subscribers to the Publisher. |
SQLDMOReplFailOver_Queued |
1 |
Use the queued updating option to propagate changes made at Subscribers to the Publisher. |
Prototype (C/C++)
HRESULT ReadReplicationFailOverMode(
SQLDMO_LPCSTR pszPublisher,
SQLDMO_LPCSTR pszPublicationDB,
SQLDMO_LPCSTR pszPublication,
SQLDMO_REPLFAILOVER_TYPE *pFailOverMode);
Remarks
The ReadReplicationFailOverMode method should be called on a ReplicationDatabase2 object that represents a subscription database. The szPublisher, szPublicationDB, and szPublication parameters identify a subscription in the subscription database.
An application must use the WriteReplicationFailOverMode method to set the failover mode for a subscription that uses immediate updating with queued updating as the failover option.
Note
If an application calls ReadReplicationFailOverMode on an instance of SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 or later" are returned.