AgentProfile.EnumParameterInfo Method

Definition

Returns information about parameters that can be set and that are available for the replication agent profile.

public:
 System::Collections::ArrayList ^ EnumParameterInfo();
public System.Collections.ArrayList EnumParameterInfo ();
member this.EnumParameterInfo : unit -> System.Collections.ArrayList
Public Function EnumParameterInfo () As ArrayList

Returns

An ArrayList of AgentProfileParameterInfo objects.

Exceptions

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

When the version is not SQL Server 2005 or later.

Remarks

Calling EnumParameterInfo reloads all profile properties for this object from the server. Call CommitPropertyChanges to save recent property changes to the server before calling this method.

The EnumParameterInfo method can be called only by a member of the sysadmin fixed server role at the Distributor.

Calling EnumParameterInfo is equivalent to executing sp_getagentparameterlist (Transact-SQL).

Applies to