Share via


Article.DestinationObjectName Property

Gets or sets the database object that is the source database object for the article at the Subscriber.

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

Syntax

'Declaration
Public Property DestinationObjectName As String 
    Get 
    Set
'Usage
Dim instance As Article 
Dim value As String 

value = instance.DestinationObjectName

instance.DestinationObjectName = value
public string DestinationObjectName { get; set; }
public:
property String^ DestinationObjectName {
    String^ get ();
    void set (String^ value);
}
member DestinationObjectName : string with get, set
function get DestinationObjectName () : String 
function set DestinationObjectName (value : String)

Property Value

Type: System.String
The name of the database object.

Remarks

This property cannot be modified on a MergeArticle object if the article already exists on the server.

For TransArticle objects, if DestinationObjectName is set after the initial snapshot has been generated, a new snapshot must be generated and all existing Subscribers must be reinitialized. For more information, see NIB Reinitialize a Subscription (RMO Programming).

The DestinationObjectName property can be retrieved by members of the sysadmin fixed server role at the Publisher and at the Subscriber (for republishing Subscribers). It can also be retrieved by members of the db_owner fixed database role on the publication database and by users who are members of the PAL. For a MergeArticle object, this property can also be retrieved by members of the replmonitor fixed database role on the Distributor.

The DestinationObjectName property can be set by members of the sysadmin fixed server role at the Publisher. It can also be set by members of the db_owner fixed database role on the publication database.

Retrieving DestinationObjectName is equivalent to executing sp_helparticle (Transact-SQL) for transactional or snapshot replication or executing sp_helpmergearticle (Transact-SQL) for merge replication.

Setting DestinationObjectName is equivalent to executing sp_addarticle (Transact-SQL) or sp_changearticle (Transact-SQL) for transactional or snapshot replication or executing sp_addmergearticle (Transact-SQL) for merge replication.

The DestinationObjectName property is a read/write property, so it is necessary to set it before the object is created when you use merge replication.

See Also

Reference

Article Class

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Define an Article (RMO Programming)

NIB View and Modify Article Properties (RMO Programming)