srv_paramsetoutput

Extended Stored Procedure Programming

Extended Stored Procedure Programming

srv_paramsetoutput

Sets the value of a return parameter.

Important  This function supersedes the srv_paramset function. srv_paramsetoutput supports the new Open Data Services data types and zero-length data.

Syntax

int srv_paramsetoutput ( SRV_PROC * srvproc,
int n,
BYTE * pbData,
ULONG cbLen,
BOOL fNull );

Arguments

srvproc

Is a handle for a client connection.

n

Is the ordinal number of the parameter to be set. The first parameter is 1.

pbData

Is a pointer to the data value to be sent back to the client as a procedure return parameter.

cbLen

Is the actual length of the data to be returned. If the data type of the parameter specifies values of a constant length and does not allow null values (for example, srvbit or srvint1), cbLen is ignored. A value of 0 signifies zero-length data if fNull is FALSE.

fNull

Is a flag indicating whether the value of the return parameter is NULL. Set this flag to TRUE if the parameter should be set to NULL. The default value is FALSE. If fNull is set to TRUE, cbLen should be set to 0 or the function will fail.

Returns

If the parameter information was successfully set, SUCCEED is returned; otherwise, FAIL. FAIL is returned when there is no current remote stored procedure, when the parameter is not a return parameter, or when the cbLen argument is invalid.