RegisteredSubscriber RegisteredSubscriber RegisteredSubscriber Class

Definition

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

public ref class RegisteredSubscriber sealed : Microsoft::SqlServer::Replication::ReplicationObject
public sealed class RegisteredSubscriber : Microsoft.SqlServer.Replication.ReplicationObject
Public NotInheritable Class RegisteredSubscriber
Inherits ReplicationObject
Inheritance
RegisteredSubscriberRegisteredSubscriberRegisteredSubscriber

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.

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.

Constructors

RegisteredSubscriber() RegisteredSubscriber() RegisteredSubscriber()

Creates a new instance of the RegisteredSubscriber class.

RegisteredSubscriber(String, ServerConnection) RegisteredSubscriber(String, ServerConnection) RegisteredSubscriber(String, ServerConnection)

Creates a new instance of the RegisteredSubscriber class with the specified name and specified connection to the Publisher.

RegisteredSubscriber(String, ServerConnection, String, String) RegisteredSubscriber(String, ServerConnection, String, String) 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.

Properties

CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
DefaultDistributionSchedule DefaultDistributionSchedule DefaultDistributionSchedule

Gets the default schedule to be assigned to the Distribution Agent if it is not specified.

DefaultMergeSchedule DefaultMergeSchedule DefaultMergeSchedule

Gets the default schedule to be assigned to the Merge Agent if it is not specified.

Description Description Description

Gets or sets a textual description of the object.

DistributionDatabase DistributionDatabase DistributionDatabase

Gets or sets the name of the distribution database that the distribution Publisher uses.

DistributionPublisher DistributionPublisher DistributionPublisher

Gets or sets the name of the distribution Publisher to which the Subscriber is registered.

IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
Name Name Name

Gets or sets the name of the registered Subscriber.

SqlServerName SqlServerName SqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
SubscriberSecurity SubscriberSecurity SubscriberSecurity

Gets a security context that is used by the Distribution Agent or the Merge Agent to connect to this registered Subscriber.

Type Type Type

Gets or sets the type of Subscriber.

UserData UserData UserData

Gets or sets an object property that allows users to attach their own data to the object.

(Inherited from ReplicationObject)

Methods

CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the definition is valid.

(Inherited from ReplicationObject)
CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create() Create() Create()

Registers the Subscriber at the specified Publisher or Distributor.

Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String)

Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean)

Returns the drop command from the replication.

(Inherited from ReplicationObject)
InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
Remove() Remove() Remove()

Removes the Subscriber registration represented by the object.

Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions)

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.

Applies to