Article.SourceObjectName Property

Gets or sets the name of the database object that is being published.

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

Syntax

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

value = instance.SourceObjectName

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

Property Value

Type: System.String
A String value that specifies the object name.

Exceptions

Exception Condition
ApplicationException

When you attempt to set the SourceObjectName property for an existing article.

ArgumentException

When you set the SourceObjectName property to a nulla null reference (Nothing in Visual Basic) value, to a value with nulla null reference (Nothing in Visual Basic) characters, or to a value longer than 128-Unicode characters.

Remarks

The SourceObjectName property is a read/write property.

The SourceObjectName property must be set before the Create method is called to create the article on the server. Attempting to set this property for an existing article generates an exception.

The SourceObjectName 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 SourceObjectName 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 SourceObjectName is equivalent to executing sp_helparticle (Transact-SQL) for transactional or snapshot replication or executing sp_helpmergearticle (Transact-SQL) for merge replication.

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

The SourceObjectName property is available with SQL Server 2005, SQL Server 2000, and SQL Server 7.0..

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