AgentProfile.EnumParameters Method

Article
12/03/2008

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

public ArrayList EnumParameters ()

public:
ArrayList^ EnumParameters ()

public ArrayList EnumParameters ()

public function EnumParameters () : ArrayList

Return Value

An ArrayList of AgentProfileParameter objects.

Exceptions

Exception type	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).

This namespace, class, or member is supported only in the .NET Framework 2.0.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms