AgentProfile.EnumParameters Method

Returns all existing parameters that are set for the replication agent profile.

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

Syntax

'Declaration
Public Function EnumParameters As ArrayList
'Usage
Dim instance As AgentProfile 
Dim returnValue As ArrayList 

returnValue = instance.EnumParameters()

public ArrayList EnumParameters()

public:
ArrayList^ EnumParameters()

member EnumParameters : unit -> ArrayList

public function EnumParameters() : ArrayList

Return Value

Type: System.Collections.ArrayList
An ArrayList of AgentProfileParameter objects.

Exceptions

Exception	Condition
ApplicationException	When the profile represented by the object does not exist on the server.

Remarks

The EnumParameters method can be called only by members of the sysadmin fixed server role at the Distributor and by members of the replmonitor fixed database role on a database at the Distributor.

Calling EnumParameters is equivalent to executing sp_help_agent_parameter (Transact-SQL).

See Also

Reference

AgentProfile Class

Microsoft.SqlServer.Replication Namespace