EnumAgentParameters Method

SQL-DMO

SQL-DMO

EnumAgentParameters Method

The EnumAgentParameters method returns a QueryResults object that enumerates startup options settings for the replication agent when the agent is started using the specified profile.

Applies To
Distributor Object
Syntax

object.EnumAgentParameters( ConfigurationID ) as QueryResults

Parts

object

Expression that evaluates to an object in the Applies To list

ConfigurationID

Long integer that identifies a replication agent profile by profile identifier

Prototype (C/C++)

HRESULT EnumAgentParameters(
LPSQLDMOQUERYRESULTS* ppResults,
long lConfigurationID);

Returns

A QueryResults object that contains one result set defined by these columns.

Column Data type Description
parameter_name nvarchar(129) Parameter name
profile_id integer Profile identifier
value nvarchar(256) Value in use for the parameter