Share via

AgentProfile Members

  • Article

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

The following tables list the members exposed by the AgentProfile type.

Public Constructors

  Name Description
AgentProfile Overloaded. Initializes a new instance of the AgentProfile class.

Top

Public Properties

  Name Description
ms155316.pubproperty(en-US,SQL.90).gif AgentType Gets or sets the type of replication agent for which the profile is intended.
ms155316.pubproperty(en-US,SQL.90).gif CachePropertyChanges  Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (inherited from ReplicationObject)
ms155316.pubproperty(en-US,SQL.90).gif ConnectionContext  Gets or sets the connection to an instance of Microsoft SQL Server. (inherited from ReplicationObject)
ms155316.pubproperty(en-US,SQL.90).gif Default Specifies whether this profile is the default profile for the given replication agent type.
ms155316.pubproperty(en-US,SQL.90).gif Description Gets or sets a textual description of the replication agent profile.
ms155316.pubproperty(en-US,SQL.90).gif IsExistingObject  Gets whether the object exists on the server or not. (inherited from ReplicationObject)
ms155316.pubproperty(en-US,SQL.90).gif Name Gets or sets the name of the replication agent profile.
ms155316.pubproperty(en-US,SQL.90).gif ProfileId  
ms155316.pubproperty(en-US,SQL.90).gif SqlServerName  Gets the name of the Microsoft SQL Server instance to which this object is connected. (inherited from ReplicationObject)
ms155316.pubproperty(en-US,SQL.90).gif Type Specifies whether the replication agent profile is pre-defined by replication or created by a user.
ms155316.pubproperty(en-US,SQL.90).gif UserData  Gets or sets an object property that allows users to attach their own data to the object. (inherited from ReplicationObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms155316.pubmethod(en-US,SQL.90).gif AddParameter Adds a parameter to the replication agent profile.
ms155316.pubmethod(en-US,SQL.90).gif AssignToAgent Assigns the replication agent profile to a specific replication agent job.
ms155316.pubmethod(en-US,SQL.90).gif ChangeParameter Changes the value of an existing replication agent parameter in the profile.
ms155316.pubmethod(en-US,SQL.90).gif CommitPropertyChanges  Sends all the cached property change statements to the instance of Microsoft SQL Server. (inherited from ReplicationObject)
ms155316.pubmethod(en-US,SQL.90).gif Create Creates the replication agent profile on the instance of SQL Server by using the current properties.
ms155316.pubmethod(en-US,SQL.90).gif Decouple  Decouples the referenced replication object from the server. (inherited from ReplicationObject)
ms155316.pubmethod(en-US,SQL.90).gif EnumParameterInfo Returns information about parameters that can be set and that are available for the replication agent profile.
ms155316.pubmethod(en-US,SQL.90).gif EnumParameters Returns all existing parameters that are set for the replication agent profile.
ms155316.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms155316.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms155316.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms155316.pubmethod(en-US,SQL.90).gif Load  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms155316.pubmethod(en-US,SQL.90).gif LoadProperties  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms155316.pubmethod(en-US,SQL.90).gif MakeDefault Sets the profile as the default profile for all replication agents of the same type.
ms155316.pubmethod(en-US,SQL.90).gifms155316.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms155316.pubmethod(en-US,SQL.90).gif Refresh  Reloads the properties of the object. (inherited from ReplicationObject)
ms155316.pubmethod(en-US,SQL.90).gif Remove Removes an existing replication agent profile from the Distributor.
ms155316.pubmethod(en-US,SQL.90).gif RemoveParameter Removes an existing parameter from the replication agent profile.
ms155316.pubmethod(en-US,SQL.90).gif Script Generates a Transact-SQL script that can be used to re-create the agent profile.
ms155316.pubmethod(en-US,SQL.90).gif ToString  (inherited from Object )

Top

Protected Methods

  Name Description
ms155316.protmethod(en-US,SQL.90).gif CheckValidCreation  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif CheckValidDefinition  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms155316.protmethod(en-US,SQL.90).gif GetChangeCommand  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif GetCreateCommand  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif GetDropCommand  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif InternalRefresh  (inherited from ReplicationObject )
ms155316.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

AgentProfile Class
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Work with Replication Agent Profiles (RMO Programming)