AgentProfile.EnumParameterInfo Method

Artykuł
12/03/2008

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

public ArrayList EnumParameterInfo ()

public:
ArrayList^ EnumParameterInfo ()

public ArrayList EnumParameterInfo ()

public function EnumParameterInfo () : ArrayList

Return Value

An ArrayList of AgentProfileParameterInfo objects.

Exceptions

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

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.

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