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 | |
|---|---|---|
.gif "Public method") |
RegisteredSubscriber() | Creates a new instance of the RegisteredSubscriber class. |
|
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) | 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 | |
|---|---|---|
.gif "Public property") |
CachePropertyChanges | Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.) |
|
ConnectionContext | Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.) |
|
DefaultDistributionSchedule | Gets the default schedule to be assigned to the Distribution Agent if it is not specified. |
|
DefaultMergeSchedule | Gets the default schedule to be assigned to the Merge Agent if it is not specified. |
|
Description | Gets or sets a textual description of the object. |
|
DistributionDatabase | Gets or sets the name of the distribution database that the distribution Publisher uses. |
|
DistributionPublisher | Gets or sets the name of the distribution Publisher to which the Subscriber is registered. |
|
IsExistingObject | Gets whether the object exists on the server or not. (Inherited from ReplicationObject.) |
|
Name | Gets or sets the name of the registered Subscriber. |
|
SqlServerName | Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.) |
|
SubscriberSecurity | Gets a security context that is used by the Distribution Agent or the Merge Agent to connect to this registered Subscriber. |
|
Type | Gets or sets the type of Subscriber. |
|
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 | |
|---|---|---|
|
CommitPropertyChanges | Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.) |
|
Create | Registers the Subscriber at the specified Publisher or Distributor. |
|
Decouple | Decouples the referenced replication object from the server. (Inherited from ReplicationObject.) |
|
Equals | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
Load | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
|
LoadProperties | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
|
Refresh | Reloads the properties of the object. (Inherited from ReplicationObject.) |
|
Remove | Removes the Subscriber registration represented by the object. |
|
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. |
|
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.
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.