Retclen()
From Lianjapedia
Revision as of 06:34, 11 April 2013 by Yvonne.milne (Talk | contribs)
PURPOSE
Return a character string
SYNONYM
api_ret_clen()
SYNOPSIS
#include "lianjaapi.h" int _retclen(string, len) <input parameters> char *string; /*Address of a buffer containing a character string */ int len; /* Length of string */ <output parameters> none
DESCRIPTION
The _retclen() function is used to pass a character pointer back to your application. The second parameter, len, is used to specify the length of the character string returned. The maximum length of a string that can be returned is 64kB. If the string is too long, an error message will be returned.
EXAMPLE
The following example evaluates the first parameter passed and returns the English translation of the logical condition with a length of 5 characters.
Example Lianja script:
m_word=ltow(.T.)
Example 'C' function:
#include "lianjaapi.h" lianjaapi_ltow() { char strbuff[6]; if (_parinfo(1) == API_LTYPE) { if ( _parl(1) == 0 ) { strcpy( strbuff, "False" ); } else { strcpy( strbuff, "True" ); } }else { strcpy(strbuff, ""); } _retclen(strbuff, 5); }
SEE ALSO
_parc(), _parclen(), _parcsiz(), _parinfo(), _retc(), ISCHAR(), CHAR_ALLTRIM(), CHAR_LOWER(), CHAR_LPAD(), CHAR_LTRIM(), CHAR_RPAD(), CHAR_RTRIM(), CHAR_STR(), CHAR_UPPER(), DATE_STOD()