AgentProfile Class
Encapsulates all operations on replication agent profiles, such as creating, deleting, adding, and removing parameters, and assigning specific profiles to certain agents.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.AgentProfile
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public NotInheritable Class AgentProfile _
Inherits ReplicationObject
'Usage
Dim instance As AgentProfile
public sealed class AgentProfile : ReplicationObject
public ref class AgentProfile sealed : public ReplicationObject
[<SealedAttribute>]
type AgentProfile =
class
inherit ReplicationObject
end
public final class AgentProfile extends ReplicationObject
The AgentProfile type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
AgentProfile() | Initializes a new instance of the AgentProfile class. |
|
AgentProfile(Int32, ServerConnection) | Initializes a new instance of the AgentProfile class with a specified agent profile ID value and server connection. |
|
AgentProfile(String, ServerConnection) | Initializes a new instance of the AgentProfile class with the specified profile name and server connection. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AgentType | Gets or sets the type of replication agent for which the profile is intended. |
|
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.) |
|
Default | Specifies whether this profile is the default profile for the given replication agent type. |
|
Description | Gets or sets a textual description of the replication agent profile. |
|
IsExistingObject | Gets whether the object exists on the server or not. (Inherited from ReplicationObject.) |
|
Name | Gets or sets the name of the replication agent profile. |
|
ProfileId | |
|
SqlServerName | Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.) |
|
Type | Specifies whether the replication agent profile is pre-defined by replication or created by a user. |
|
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 | |
|---|---|---|
|
AddParameter | Adds a parameter to the replication agent profile. |
|
AssignToAgent | Assigns the replication agent profile to a specific replication agent job. |
|
ChangeParameter | Changes the value of an existing replication agent parameter in the profile. |
|
CommitPropertyChanges | Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.) |
|
Create | Creates the replication agent profile on the instance of SQL Server by using the current properties. |
|
Decouple | Decouples the referenced replication object from the server. (Inherited from ReplicationObject.) |
|
EnumParameterInfo | Returns information about parameters that can be set and that are available for the replication agent profile. |
|
EnumParameters | Returns all existing parameters that are set for the replication agent profile. |
|
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.) |
|
MakeDefault | Sets the profile as the default profile for all replication agents of the same type. |
|
Refresh | Reloads the properties of the object. (Inherited from ReplicationObject.) |
|
Remove | Removes an existing replication agent profile from the Distributor. |
|
RemoveParameter | Removes an existing parameter from the replication agent profile. |
|
Script | Generates a Transact-SQL script that can be used to re-create the agent profile. |
|
ToString | (Inherited from Object.) |
Top
Remarks
Thread Safety
Public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. 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.
See Also
Reference
Microsoft.SqlServer.Replication Namespace