Retc()

PURPOSE

Pass a character string to Recital

SYNONYM

api_ret_c()

SYNOPSIS

#include "dbapi.h"
 
int	_retc(string)
 
<input parameters>
char	*string;		/* Address of a buffer containing a character string	*/
 
<output parameters>
none

DESCRIPTION

The _retc() function is used to pass a character string back to Recital. The maximum length of a string that can be returned to Recital is 8192. If the string is too long, Recital will return an error message.

EXAMPLE

The following example evaluates the first parameter passed and returns the English translation of the logical condition.

Example Recital program:

m_word=ltow(.T.)

Example 'C' function:

#include "dbapi.h"
 
dbapi_ltow()
{
    char	strbuff[6];
 
    if ( _parinfo(1) == API_LTYPE ) {
       if ( _parl(1) == 0 ) {
       strcpy( strbuff, "False" );
       } else {
       strcpy( strbuff, "True" );
       }
    }else {
       strcpy(strbuff, "");
    }
 
    _retc( strbuff  );
}

SEE ALSO

_parc(), _parclen(), _parcsiz(), _parinfo(), _retclen(), ISCHAR(), CHAR_ALLTRIM(), CHAR_LOWER(), CHAR_LPAD(), CHAR_LTRIM(), CHAR_RPAD(), CHAR_RTRIM(), CHAR_STR(), CHAR_UPPER(), DATE_STOD()