Article.DestinationObjectName Property

  • Article

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

public string DestinationObjectName { get; set; }

public:
property String^ DestinationObjectName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_DestinationObjectName ()

/** @property */
public void set_DestinationObjectName (String value)

public function get DestinationObjectName () : String

public function set DestinationObjectName (value : String)

Property Value

A String value that specifies 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 How to: 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.

The DestinationObjectName property is available with SQL Server 2005 and SQL Server 2000. The property is also available with SQL Server 7.0 for transactional and snapshot replication only.

This namespace, class, or member is supported only in the .NET Framework 2.0.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Article Class
Article Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Define an Article (RMO Programming)
How to: View and Modify Article Properties (RMO Programming)