• Article

AgentProfile Members

Include Protected Members
Include Inherited Members

Encapsulates all operations on replication agent profiles, such as creating, deleting, adding, and removing parameters, and assigning specific profiles to certain agents.

The AgentProfile type exposes the following members.

Constructors

  Name Description
Public method AgentProfile() Initializes a new instance of the AgentProfile class.
Public method AgentProfile(Int32, ServerConnection) Initializes a new instance of the AgentProfile class with a specified agent profile ID value and server connection.
Public method AgentProfile(String, ServerConnection) Initializes a new instance of the AgentProfile class with the specified profile name and server connection.

Top

Methods

  Name Description
Public method AddParameter(String, String) Adds a parameter to the replication agent profile.
Public method AssignToAgent(String, Int32) Assigns the replication agent profile to a specific replication agent job.
Public method ChangeParameter(String, String) Changes the value of an existing replication agent parameter in the profile.
Protected method CheckValidCreation() Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition(Boolean) 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() Creates the replication agent profile on the instance of SQL Server by using the current properties. 
Public method Decouple() Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumParameterInfo() Returns information about parameters that can be set and that are available for the replication agent profile.
Public method EnumParameters() Returns all existing parameters that are set for the replication agent profile.
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method GetChangeCommand(StringBuilder, String, String) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand(StringBuilder, Boolean, ScriptOptions) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand(StringBuilder, Boolean) Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Protected method InternalRefresh(Boolean) 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.)
Public method MakeDefault() Sets the profile as the default profile for all replication agents of the same type.
Protected method MemberwiseClone() (Inherited from Object.)
Public method Refresh() Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method Remove() Removes an existing replication agent profile from the Distributor.
Public method RemoveParameter(String) Removes an existing parameter from the replication agent profile.
Public method Script(ScriptOptions) Generates a Transact-SQL script that can be used to re-create the agent profile.
Public method ToString() (Inherited from Object.)

Top

Properties

  Name Description
Public property AgentType Gets or sets the type of replication agent for which the profile is intended.
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 Default Specifies whether this profile is the default profile for the given replication agent type.
Public property Description Gets or sets a textual description of the replication agent profile.
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 replication agent profile.
Public property ProfileId
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Type Specifies whether the replication agent profile is pre-defined by replication or created by a user.
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top