Database Vuser Functions (LRD) > Alphabetical List of Functions > lrd_save_ret_param

lrd_save_ret_param

Example: lrd_save_ret_param Correlating Statements Functions

Saves a return-parameter to a parameter

LRDRET lrd_save_ret_param( LRD_CURSOR *mptCursor, unsigned int muiRetParamNum, unsigned long muliOption, char *mpszParamName );


mptCursor A pointer to an LRD_CURSOR structure.
muiRetParamNum A "0" indicates the return status. A non-zero value indicates the return-parameter number (DbLib).
muliOption One of the Save Return Parameter Options.
mpszParamName A pointer to the parameter name using alpha-numerical characters, enclosed by quotation marks.

The lrd_save_ret_param function saves the value of a stored procedure's return-parameter, to a parameter. If the function cannot retrieve the return-parameter, the parameter is marked as uninitialized. This function is used for Correlating Database Statements.

To generate an lrd_save_ret_param function, right click on the value in the grid that you want to correlate (following lrd_result_set) and choose Create Correlation. After prompting you for a parameter name, VuGen places an lrd_save_ret_param function before the grid.

For more details refer to the DbLib documentation for dbretdata and the Function Header File, Lrd.h.

Return Values

See LRD Return Values.

Parameterization

You cannot use standard parameterization for any arguments in this function.