EnumAlternatePublishers 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 EnumAlternatePublisher method enumerates all servers in a list of alternate Publishers.
Syntax
object.EnumAlternatePublishers( )as QueryResults
Parts
- object
Expression that evaluates to an object in the Applies To list.
Prototype (C/C++)
HRESULT EnumAlternatePublishers(LPSQLDMOQUERYRESULTS *ppResults);
Returns
A QueryResults object that contains one result set defined by these columns.
Column |
Data type |
Description |
|---|---|---|
alternate_distributor |
sysname |
Name of the Distributor. |
alternate_publication |
sysname |
Name of the publication. |
alternate_publisher |
sysname |
Name of the alternate Publisher. |
alternate_publisher_db |
sysname |
Name of the publication database. |
enabled |
bit |
Whether the server is an alternate Publisher. |
friendly_name |
nvarchar(255) |
Description of the alternate Publisher. |
Remarks
Run the EnumAlternatePublishers method to obtain a list of enabled alternate Publishers. The enabled bit is set to 1 if a server is an enabled alternate Publisher, and is set to zero if the server is not enabled as an alternate Publisher. Subscribers can then synchronize with any listed alternate Publisher, a technique that provides an efficient way to synchronize a mobile Subscriber not connected to the Publisher with which it ordinarily synchronizes data changes.
The AllowSyncToAlternate property must be set to TRUE for subscriptions to synchronize with an alternate Publisher.
Use the AddAlternatePublisher method to add a server to the list of alternate Publishers.
Note
If an application calls EnumAlternatePublishers 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.