Functions and Directives Functions and Directives

Function _retl() Foundation

Returns a logical value to Xbase++.

Syntax
BOOL _retl(XppParamList pList, BOOL lValue);
Parameters
XppParamList pList
Pointer to the Xbase++ parameter list of the function whose return value is being set.
BOOL lValue
Logical value which is to be returned (1 = TRUE, 0 = FALSE).
Return

Always returns TRUE.

Description

_retl() is used to return a logical value. Calling this function does not exit the actual function, but merely sets the return value. After the call an access to other C-API functions except for _conRelease()is not allowed anymore and the function should return immediately.

To insure correct operation, a return value has always to be set. In Xbase++, NIL should be returned for procedures, which are functions without return values.

Examples
/* 
Return of a logical value. 
*/ 
#include <xpppar.h> 

retl(<pList>, TRUE);
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.