EnumParameters Method

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The EnumParameters method returns a QueryResults object that enumerates the parameters of a Microsoft SQL Server stored procedure or user-defined function.

Syntax

object.EnumParameters( )as QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

Prototype (C/C++)

HRESULT EnumParameters(
LPSQLDMOQUERYRESULTS* ppResults);

Returns

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

Column

Data type

Description

colid

smallint

Ordinal position of the parameter.

length

smallint

Length modifier for the parameter data type when applicable, such as in nchar(5).

name

nvarchar(129)

Parameter name.

name

nvarchar(129)

Name of the parameter data type.

output

tinyint

When 1, the parameter is input/output or output.

Remarks

When a stored procedure or user-defined function has no defined parameters, method execution succeeds and the result set returned is empty. The Rows property of the QueryResults object returns 0.