Export (0) Print
Expand All

AgentProfile Class

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

Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.AgentProfile

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

public sealed class AgentProfile : ReplicationObject

The AgentProfile type exposes the following members.

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

  NameDescription
Public propertyAgentTypeGets or sets the type of replication agent for which the profile is intended.
Public propertyCachePropertyChangesGets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public propertyConnectionContextGets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public propertyDefaultSpecifies whether this profile is the default profile for the given replication agent type.
Public propertyDescriptionGets or sets a textual description of the replication agent profile.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyNameGets or sets the name of the replication agent profile.
Public propertyProfileId
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertyTypeSpecifies whether the replication agent profile is pre-defined by replication or created by a user.
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Top

  NameDescription
Public methodAddParameterAdds a parameter to the replication agent profile.
Public methodAssignToAgentAssigns the replication agent profile to a specific replication agent job.
Public methodChangeParameterChanges the value of an existing replication agent parameter in the profile.
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates the replication agent profile on the instance of SQL Server by using the current properties. 
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEnumParameterInfoReturns information about parameters that can be set and that are available for the replication agent profile.
Public methodEnumParametersReturns all existing parameters that are set for the replication agent profile.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoadLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodLoadPropertiesLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodMakeDefaultSets the profile as the default profile for all replication agents of the same type.
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodRemoveRemoves an existing replication agent profile from the Distributor.
Public methodRemoveParameterRemoves an existing parameter from the replication agent profile.
Public methodScriptGenerates a Transact-SQL script that can be used to re-create the agent profile.
Public methodToString (Inherited from Object.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft