AgentProfile.EnumParameterInfo Method
Returns information about parameters that can be set and that are available for the replication agent profile.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public Function EnumParameterInfo As ArrayList
'Usage
Dim instance As AgentProfile
Dim returnValue As ArrayList
returnValue = instance.EnumParameterInfo()
public ArrayList EnumParameterInfo()
public:
ArrayList^ EnumParameterInfo()
member EnumParameterInfo : unit -> ArrayList
public function EnumParameterInfo() : ArrayList
Return Value
Type: System.Collections.ArrayList
An ArrayList of AgentProfileParameterInfo objects.
Exceptions
| Exception | Condition |
|---|---|
| ApplicationException | 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).
The EnumParameterInfo method is available for SQL Server 2005 and later.
This namespace, class, or member is supported only in the .NET Framework 2.0.