RegisteredSubscriber Class

Represents a Subscriber that has been registered at a Publisher or a Distributor.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.RegisteredSubscriber

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

Syntax

'Declaration
Public NotInheritable Class RegisteredSubscriber _
    Inherits ReplicationObject
'Usage
Dim instance As RegisteredSubscriber
public sealed class RegisteredSubscriber : ReplicationObject
public ref class RegisteredSubscriber sealed : public ReplicationObject
[<SealedAttribute>]
type RegisteredSubscriber =  
    class
        inherit ReplicationObject
    end
public final class RegisteredSubscriber extends ReplicationObject

The RegisteredSubscriber type exposes the following members.

Constructors

  Name Description
Public method RegisteredSubscriber() Creates a new instance of the RegisteredSubscriber class.
Public method RegisteredSubscriber(String, ServerConnection) Creates a new instance of the RegisteredSubscriber class with the specified name and specified connection to the Publisher.
Public method RegisteredSubscriber(String, ServerConnection, String, String) Creates a new instance of the RegisteredSubscriber class with the specified name, the specified connection to the distribution Publisher, the specified distribution Publisher, and the distribution database.

Top

Properties

  Name Description
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property DefaultDistributionSchedule Gets the default schedule to be assigned to the Distribution Agent if it is not specified.
Public property DefaultMergeSchedule Gets the default schedule to be assigned to the Merge Agent if it is not specified.
Public property Description Gets or sets a textual description of the object.
Public property DistributionDatabase Gets or sets the name of the distribution database that the distribution Publisher uses.
Public property DistributionPublisher Gets or sets the name of the distribution Publisher to which the Subscriber is registered.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets or sets the name of the registered Subscriber.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property SubscriberSecurity Gets a security context that is used by the Distribution Agent or the Merge Agent to connect to this registered Subscriber.
Public property Type Gets or sets the type of Subscriber.
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

  Name Description
Protected method CheckValidCreation Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. (Inherited from ReplicationObject.)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method Create Registers the Subscriber at the specified Publisher or Distributor.
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InternalRefresh Infrastructure. (Inherited from ReplicationObject.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method Remove Removes the Subscriber registration represented by the object.
Public method Script Returns a string containing a Transact-SQL creation or deletion script for the Microsoft SQL Server registered Subscriber on the server computer that the object represents.
Public method ToString (Inherited from Object.)

Top

Remarks

In Microsoft SQL Server 2005, it is no longer required to explicitly register a Subscriber at the Publisher. The RegisteredSubscriber class is provided for backward compatibility with previous versions of SQL Server.

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

Thread Safety

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

Thread Safety

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