SqlRetName$

Returns the name of a return parameter of a stored procedure or a remote stored procedure.

Syntax

SqlRetName$ ( sqlconn%, retnum% )

where

sqlconn%

Is a SQL Server connection. The value of sqlconn% is returned by SqlOpen%.

retnum%

Is the number of the returned value of interest. The first return value is number 1. Values are returned in the same order as the parameters were originally specified in the stored procedure's CREATE PROCEDURE statement. (Note that this is not necessarily the same order as that specified in the remote stored procedure.) When specifying retnum%, non-return parameters are not counted. For example, if the second parameter in a stored procedure is the only return parameter, its retnum% is 1, not 2.

Returns

The name of the parameter of the specified return value. If retnum% is out of range, SqlRetName$ returns an empty string.

Remarks

For more information about stored procedure return parameters, see "SqlRetData$."

The server returns stored procedure information (including any return status and parameter values) immediately after returning all normal results for that stored procedure. Process the normal results, and then call SqlRetName$ after SqlResults% returns NOMORERPCRESULTS (for all stored procedures in a batch except the last one) or NOMORERESULTS (for a single stored procedure, or for the last stored procedure in a batch).

See Also

SqlNextRow%, SqlNumRets%, SqlResults%, SqlRetData$, SqlRetLen&, SqlRetType%