From 239c774e94cf2ce495b84a075eb56107a2d1ed59 Mon Sep 17 00:00:00 2001 From: April White Date: Sat, 12 Aug 2000 19:15:34 +0000 Subject: [PATCH] Changelog: 2000-08-12 20:00 UTC+0500 April White disregard my: 2000-07-29 03:00 UTC+0500 TODO: remove the old hb*.txt files from doc/en * doc/en/ + hb_api.txt hb_apier.txt hb_apifs.txt hb_apigt.txt hb_apiit.txt + hb_apiln.txt hb_apird.txt hb_compa.txt hb_date.txt hb_macro.txt + hb_set.txt hb_vm.txt --- harbour/doc/en/hb_api.txt | 7621 +++++++++++++++++++++++++++++++++ harbour/doc/en/hb_apier.txt | 1377 ++++++ harbour/doc/en/hb_apifs.txt | 1302 ++++++ harbour/doc/en/hb_apigt.txt | 4326 +++++++++++++++++++ harbour/doc/en/hb_apiit.txt | 2033 +++++++++ harbour/doc/en/hb_apiln.txt | 345 ++ harbour/doc/en/hb_apird.txt | 7901 +++++++++++++++++++++++++++++++++++ harbour/doc/en/hb_compa.txt | 5130 +++++++++++++++++++++++ harbour/doc/en/hb_date.txt | 480 +++ harbour/doc/en/hb_macro.txt | 1062 +++++ harbour/doc/en/hb_set.txt | 81 + harbour/doc/en/hb_vm.txt | 986 +++++ 12 files changed, 32644 insertions(+) create mode 100644 harbour/doc/en/hb_api.txt create mode 100644 harbour/doc/en/hb_apier.txt create mode 100644 harbour/doc/en/hb_apifs.txt create mode 100644 harbour/doc/en/hb_apigt.txt create mode 100644 harbour/doc/en/hb_apiit.txt create mode 100644 harbour/doc/en/hb_apiln.txt create mode 100644 harbour/doc/en/hb_apird.txt create mode 100644 harbour/doc/en/hb_compa.txt create mode 100644 harbour/doc/en/hb_date.txt create mode 100644 harbour/doc/en/hb_macro.txt create mode 100644 harbour/doc/en/hb_set.txt create mode 100644 harbour/doc/en/hb_vm.txt diff --git a/harbour/doc/en/hb_api.txt b/harbour/doc/en/hb_api.txt new file mode 100644 index 0000000000..e85faf1d48 --- /dev/null +++ b/harbour/doc/en/hb_api.txt @@ -0,0 +1,7621 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Antonio Linares + * Header file for the Extend API, Array API, misc API and base declarations + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a string parameter + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parc( int iParam, ... ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parclen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a string parameter length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parclen( int iParam, ... ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parcsiz() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a by-reference string parameter length, including terminator + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parcsiz( int iParam, ... ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_pards() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a date as a string yyyymmdd + * $SYNTAX$ + * C Prototype + * + * #include + * hb_pards( int iParam, ... ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_pardsbuff() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a date as a string yyyymmdd + * $SYNTAX$ + * C Prototype + * + * #include + * hb_pardsbuff( char * szDate, int iParam, ... ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parinfa() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve length or element type of an array parameter + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parinfa( int iParamNum, ULONG uiArrayIndex ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parinfo() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Determine the param count or data type + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parinfo( int iParam ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a logical parameter as an int + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parl( int iParam, ... ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parnd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a numeric parameter as a double + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parnd( int iParam, ... ) --> ( double )dResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parni() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a numeric parameter as a integer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parni( int iParam, ... ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_parnl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a numeric parameter as a long + * $SYNTAX$ + * C Prototype + * + * #include + * hb_parnl( int iParam, ... ) --> ( long )lResult + * $ARGUMENTS$ + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_param() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a generic parameter + * $SYNTAX$ + * C Prototype + * + * #include + * hb_param( int iParam, int iMask ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_pcount() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns the number of suplied parameters + * $SYNTAX$ + * C Prototype + * + * #include + * hb_pcount( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_ret() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Post a NIL return value + * $SYNTAX$ + * C Prototype + * + * #include + * hb_ret( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retc( char * szText ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retclen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a string with a specific length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retclen( char * szText, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retds() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a date, must use yyyymmdd format + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retds( char * szDate ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a date + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retd( long lYear, long lMonth, long lDay ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retdl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a long value as a julian date + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retdl( long lJulian ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a logical integer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retl( int iTrueFalse ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a double + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retnd( double dNumber ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retni() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a integer number + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retni( int iNumber ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a long number + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retnl( long lNumber ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnlen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a double, with specific width and decimals + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retnlen( double dNumber, int iWidth, int iDec ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retndlen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a double, with specific width and decimals + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retndlen( double dNumber, int iWidth, int iDec ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnilen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a integer number, with specific width + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retnilen( int iNumber, int iWidth ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnllen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a long number, with specific width + * $SYNTAX$ + * C Prototype + * + * #include + * hb_retnllen( long lNumber, int iWidth ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_reta() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns an array with a specific length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_reta( ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_storc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores a szString on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_storc( char * szText, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_storclen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores a fixed length string on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_storclen( char * szText, ULONG ulLength, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stords() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * SzDate must have yyyymmdd format + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stords( char * szDate, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_storl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores a logical integer on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_storl( int iLogical, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_storni() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores an integer on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_storni( int iValue, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stornl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores a long on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stornl( long lValue, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stornd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Stores a double on a variable by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stornd( double dValue, int iParam, ... ) --> void + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xinit() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Initialize fixed memory subsystem + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xinit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xexit() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Deinitialize fixed memory subsystem + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xexit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xalloc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Allocates memory, returns NULL on failure + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xalloc( ULONG ulSize ) --> ( void * )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xgrab() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Allocates memory, exits on failure + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xgrab( ULONG ulSize ) --> ( void * )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xfree() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Frees memory + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xfree( void * pMem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xrealloc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Reallocates memory + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xrealloc( void * pMem, ULONG ulSize ) --> ( void * )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xsize() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns the size of an allocated memory block + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xsize( void * pMem ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xquery() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Query different types of memory information + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xquery( USHORT uiMode ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xmemcpy() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy more than memcpy() can + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xmemcpy( void * pDestArg, void * pSourceArg, ULONG ulLen ) --> ( void * )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not UINT_MAX == ULONG_MAX + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xmemset() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Set more than memset() can + * $SYNTAX$ + * C Prototype + * + * #include + * hb_xmemset( void * pDestArg, int iFill, ULONG ulLen ) --> ( void * )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: not UINT_MAX == ULONG_MAX + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Creates a new array + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayNew( PHB_ITEM pItem, ULONG ulLen ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayLen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrives the array len + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayLen( PHB_ITEM pArray ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayIsObject() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrives if the array is an object + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayIsObject( PHB_ITEM pArray ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayAdd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Add a new item to the end of an array item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayAdd( PHB_ITEM pArray, PHB_ITEM pItemValue ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayIns() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Insert a nil item into an array, without changing the length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayIns( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayDel() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Delete an array item, without changing length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayDel( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arraySize() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Sets the array total length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arraySize( PHB_ITEM pArray, ULONG ulLen ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayLast() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve last item in an array + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayLast( PHB_ITEM pArray, PHB_ITEM pResult ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayRelease() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Releases an array - don't call it - use ItemRelease() !!! + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayRelease( PHB_ITEM pArray ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arraySet() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Sets an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arraySet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGet() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves an item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetItemPtr() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns pointer to specified element of the array + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetItemPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayCopyC() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy a string into an array item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayCopyC( PHB_ITEM pArray, ULONG ulIndex, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetC() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the string contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetC( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetCPtr() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the string pointer on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetCPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetCLen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the string length contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetCLen( PHB_ITEM pArray, ULONG ulIndex ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the logical value contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetL( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetNI() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the int value contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetNI( PHB_ITEM pArray, ULONG ulIndex ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetNL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the long numeric value contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetNL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetND() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the double value contained on an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetND( PHB_ITEM pArray, ULONG ulIndex ) --> ( double )dResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetDS() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the date value contained in an array element + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetDS( PHB_ITEM pArray, ULONG ulIndex, char * szDate ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetDL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the date value contained in an array element, as a long integer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetDL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayGetType() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves the type of an array item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayGetType( PHB_ITEM pArray, ULONG ulIndex ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayFill() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Fill an array with a given item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayFill( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayScan() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Scan an array for a given item, or until code-block item returns TRUE + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayScan( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayEval() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Execute a code-block for every element of an array item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayEval( PHB_ITEM pArray, PHB_ITEM bBlock, ULONG * pulStart, ULONG * pulCount ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayCopy() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy items from one array to another + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayCopy( PHB_ITEM pSrcArray, PHB_ITEM pDstArray, ULONG * pulStart, ULONG * pulCount, ULONG * pulTarget ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayClone() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a duplicate of an existing array, including all nested items + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayClone( PHB_ITEM pArray ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arraySort() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Sorts an array item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arraySort( PHB_ITEM pArray, ULONG * pulStart, ULONG * pulCount, PHB_ITEM pBlock ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stricmp() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compare two strings without regards to case + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stricmp( const char * s1, const char * s2 ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strnicmp() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compare two string without regards to case, limited by length + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strnicmp( const char * s1, const char * s2, ULONG ulLen ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strupr() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Convert a string in-place to upper-case + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strupr( char * pszText ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strdup() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns a pointer to a newly allocated copy of the source string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strdup( const char * pszText ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strMatchRegExp() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compare two strings using a regular expression pattern + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strMatchRegExp( const char * szString, const char * szMask ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strEmpty() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns whether a string contains only white space + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strEmpty( const char * szText, ULONG ulLen ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strDescend() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy a string to a buffer, inverting each character + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strDescend( char * szStringTo, const char * szStringFrom, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strAt() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns an index to a sub-string within another string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strAt( const char * szSub, ULONG ulSubLen, const char * szText, ULONG ulLen ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strUpper() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Convert an existing string buffer to upper case + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strUpper( char * szText, ULONG ulLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strLower() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Convert an existing string buffer to lower case + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strLower( char * szText, ULONG ulLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strncpyUpper() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy an existing string buffer to another buffer, as upper case + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strncpyUpper( char * pDest, const char * pSource, ULONG ulLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strVal() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Return the numeric value of a character string representation of a number + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strVal( const char * szText, ULONG ulLen ) --> ( double )dResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strLTrim() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Return a pointer to the first non-white space character + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strLTrim( const char * szText, ULONG * ulLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_strRTrimLen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Return length of a string, ignoring trailing white space (or true spaces) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_strRTrimLen( const char * szText, ULONG ulLen, BOOL bAnySpace ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_numRound() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Round a number to a specific number of digits + * $SYNTAX$ + * C Prototype + * + * #include + * hb_numRound( double dResult, int iDec ) --> ( double )dResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_clsReleaseAll() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Releases all defined classes + * $SYNTAX$ + * C Prototype + * + * #include + * hb_clsReleaseAll( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_objGetClsName() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves an object class name + * $SYNTAX$ + * C Prototype + * + * #include + * hb_objGetClsName( PHB_ITEM pObject ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_objGetMethod() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns the method pointer of a object class + * $SYNTAX$ + * C Prototype + * + * #include + * hb_objGetMethod( PHB_ITEM pObject, PHB_SYMB pSymMsg ) --> ( PHB_FUNC )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_objHasMsg() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns TRUE/FALSE whether szString is an existing message for object + * $SYNTAX$ + * C Prototype + * + * #include + * hb_objHasMsg( PHB_ITEM pObject, char * szString ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymGet() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Finds and creates a dynamic symbol if not found + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymGet( char * szName ) --> ( PHB_DYNS )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Creates a new dynamic symbol based on a local one + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymNew( PHB_SYMB pSymbol ) --> ( PHB_DYNS )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymFind() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Finds a dynamic symbol + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymFind( char * szName ) --> ( PHB_DYNS )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymFindName() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Converts to uppercase and finds a dynamic symbol + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymFindName( char * szName ) --> ( PHB_DYNS )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymLog() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Displays all dynamic symbols + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymLog( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymRelease() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Releases the memory of the dynamic symbol table + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymRelease( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dynsymEval() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Enumerates all dynamic symbols + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dynsymEval( PHB_DYNS_FUNC pFunction, void * Cargo ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargInit() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Initialize command line argument API's + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargInit( int argc, char * argv[] ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargARGC() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve command line argument count + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargARGC( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargARGV() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve command line argument buffer pointer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargARGV( void ) --> ( char ** )ppszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargIsInternal() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Determine if a string is an internal setting + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargIsInternal( const char * szArg ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargCheck() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Check if a given internal switch (like //INFO) was set + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargCheck( const char * pszName ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargString() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns the string value of an internal switch (like //TEMPPATH:"C:\") + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargString( const char * pszName ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargNum() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Returns the numeric value of an internal switch (like //F:90) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargNum( const char * pszName ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_cmdargProcessVM() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Check for command line internal arguments + * $SYNTAX$ + * C Prototype + * + * #include + * hb_cmdargProcessVM( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_symbolNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Create a new symbol + * $SYNTAX$ + * C Prototype + * + * #include + * hb_symbolNew( char * szName ) --> ( PHB_SYMB )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Create a code-block + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockNew( BYTE * pBuffer, USHORT uiLocals, USHORT * pLocalPosTable, PHB_SYMB pSymbols ) --> ( HB_CODEBLOCK_PTR )hResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockMacroNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockMacroNew( BYTE * pBuffer, USHORT usLen ) --> ( HB_CODEBLOCK_PTR )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockDelete() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Delete a codeblock + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockDelete( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockGetVar() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Get local variable referenced in a codeblock + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockGetVar( PHB_ITEM pItem, LONG iItemPos ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockGetRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Get local variable passed by reference + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockGetRef( PHB_ITEM pItem, PHB_ITEM pRefer ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockEvaluate() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Evaluate a codeblock + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockEvaluate( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockCopy() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy a codeblock + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockCopy( PHB_ITEM pDest, PHB_ITEM pSource ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarValueNew() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Create a new global value + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarValueNew( HB_ITEM_PTR pSource, BOOL bTrueMemvar ) --> ( HB_HANDLE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarValueBaseAddress() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve the base address of the values table + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarValueBaseAddress( void ) --> ( HB_VALUE_PTR * )phResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarsInit() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Initialize the memvar API system + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarsInit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarsRelease() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Clear all PUBLIC and PRIVATE variables + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarsRelease( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarsFree() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Release the memvar API system + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarsFree( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarValueIncRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Increase the reference count of a global value + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarValueIncRef( HB_HANDLE hValue ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarValueDecRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Decrease the reference count of a global value + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarValueDecRef( HB_HANDLE hValue ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarSetValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy an item into a symbol + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarSetValue( PHB_SYMB pMemvarSymb, HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarGet() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy an symbol value into an item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarGet( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarGetValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy an symbol value into an item, with error trapping + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarGetValue( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarGetRefer() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Copy a reference to a symbol value into an item, with error trapping + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarGetRefer( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarGetPrivatesBase() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve current PRIVATE variables stack base + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarGetPrivatesBase( void ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarSetPrivatesBase() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Release PRIVATE variables created after specified base + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarSetPrivatesBase( ULONG ulBase ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarNewParameter() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarNewParameter( PHB_SYMB pSymbol, PHB_ITEM pValue ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarGetStrValuePtr() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarGetStrValuePtr( char * szVarName, ULONG *pulLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * <*pulLen> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarCreateFromItem() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarCreateFromItem( PHB_ITEM pMemvar, BYTE bScope, PHB_ITEM pValue ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarScope() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve scope of a dynamic variable symbol + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarScope( char * szVarName, ULONG ulLength ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conInit() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Initialize the console API system + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conInit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conRelease() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Release the console API system + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conRelease( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conNewLine() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a pointer to a static buffer containing new-line characters + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conNewLine( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conOutStd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Output an string to STDOUT + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conOutStd( char * pStr, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conOutErr() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Output an string to STDERR + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conOutErr( char * pStr, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conSetCursor() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve and optionally set cursor shape + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conSetCursor( BOOL bSetCursor, USHORT usNewCursor ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conSetColor() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve and optionally set console color + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conSetColor( char * szColor ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_conXSaveRestRelease() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Release the save/restore API + * $SYNTAX$ + * C Prototype + * + * #include + * hb_conXSaveRestRelease( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compReservedName() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Determines if a string contains a reserve word + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compReservedName( char * szName ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_procname() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve a procedure name into a buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_procname( int iLevel, char * szName ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroGetValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieve results of a macro expansion + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroGetValue( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroSetValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Assign a value to a macro-expression item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroSetValue( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroTextValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Macro text substitution + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroTextValue( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroPushSymbol() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Handle a macro function calls, e.g. var := ¯o() + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroPushSymbol( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroRun() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Executes pcode compiled by macro compiler + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroRun( HB_MACRO_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroCompile() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compile a string and return a pcode buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroCompile( char * szString ) --> ( HB_MACRO_PTR )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroDelete() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Release all memory allocated for macro evaluation + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroDelete( HB_MACRO_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroTextSubst() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Substitute macro variables occurences within a given string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroTextSubst( char * szString, ULONG *pulStringLen ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * <*pulStringLen> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroIsIdent() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Determine if a string is a valid function or variable name + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroIsIdent( char * szString ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroPopAliasedValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compiles and evaluates an aliased macro expression + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroPopAliasedValue( HB_ITEM_PTR pAlias, HB_ITEM_PTR pVar ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroPushAliasedValue() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Compiles and evaluates an aliased macro expression + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroPushAliasedValue( HB_ITEM_PTR pAlias, HB_ITEM_PTR pVar ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroGetType() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Determine the type of an expression + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroGetType( HB_ITEM_PTR pItem ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcAlloc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Allocates a memory controlled by the garbage collector + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcAlloc( ULONG ulSize, HB_GARBAGE_FUNC_PTR pFunc ) --> ( void * )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcFree() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Deallocates a memory allocated by the garbage collector + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcFree( void *pAlloc ) --> void + * $ARGUMENTS$ + * <*pAlloc> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcLock() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Do not release passed memory block + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcLock( void *pAlloc ) --> ( void * )pResult + * $ARGUMENTS$ + * <*pAlloc> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcUnlock() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Passed block is allowed to be released + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcUnlock( void *pAlloc ) --> ( void * )pResult + * $ARGUMENTS$ + * <*pAlloc> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcLockItem() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Do not release a memory block stored inside an item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcLockItem( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcUnlockItem() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Allow to release the item + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcUnlockItem( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcCollect() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Checks if a single memory block can be released + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcCollect( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcCollectAll() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Checks if all memory blocks can be released + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcCollectAll( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gcItemRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Checks if passed item refers passed memory block pointer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gcItemRef( HB_ITEM_PTR pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmIsLocalRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Hvm.c - mark all local variables as used + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmIsLocalRef( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmIsStaticRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Hvm.c - mark all static variables as used + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmIsStaticRef( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_memvarsIsMemvarRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Memvars.c - mark all memvar variables as used + * $SYNTAX$ + * C Prototype + * + * #include + * hb_memvarsIsMemvarRef( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_clsIsClassRef() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Classes.c - mark all class internals as used + * $SYNTAX$ + * C Prototype + * + * #include + * hb_clsIsClassRef( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_codeblockDeleteGarbage() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Clear a codeblock before releasing by the GC + * $SYNTAX$ + * C Prototype + * + * #include + * hb_codeblockDeleteGarbage( void * Cargo ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_arrayReleaseGarbage() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Clear an array before releasing by the GC + * $SYNTAX$ + * C Prototype + * + * #include + * hb_arrayReleaseGarbage( void * Cargo ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_idleState() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Services a single idle state + * $SYNTAX$ + * C Prototype + * + * #include + * hb_idleState( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_idleShutDown() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Closes all background tasks + * $SYNTAX$ + * C Prototype + * + * #include + * hb_idleShutDown( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_verPlatform() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves a newly allocated buffer containing platform version + * $SYNTAX$ + * C Prototype + * + * #include + * hb_verPlatform( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_verCompiler() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves a newly allocated buffer containing compiler version + * $SYNTAX$ + * C Prototype + * + * #include + * hb_verCompiler( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_verHarbour() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Retrieves a newly allocated buffer containing harbour version + * $SYNTAX$ + * C Prototype + * + * #include + * hb_verHarbour( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_verBuildInfo() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Display harbour, compiler, and platform versions to standard console + * $SYNTAX$ + * C Prototype + * + * #include + * hb_verBuildInfo( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_OF_TYPE() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_OF_TYPE( p, t ) --> type & ~HB_IT_BYREF ) == t )> + * $ARGUMENTS$ + *

+ * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_BYREF() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_BYREF( p ) --> type & HB_IT_BYREF )> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_ARRAY() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_ARRAY( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_NIL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_NIL( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_BLOCK() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_BLOCK( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_DATE() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_DATE( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_DOUBLE() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_DOUBLE( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_INTEGER() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_INTEGER( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_LOGICAL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_LOGICAL( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_LONG() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_LONG( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_NUMERIC() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_NUMERIC( p ) --> type & HB_IT_NUMERIC )> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_OBJECT() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_OBJECT( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_STRING() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_STRING( p ) --> type & ~( HB_IT_BYREF | HB_IT_MEMOFLAG ) ) == HB_IT_STRING )> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_MEMO() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_MEMO( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_SYMBOL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_SYMBOL( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_MEMVAR() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_MEMVAR( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_IS_POINTER() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_IS_POINTER( p ) --> + * $ARGUMENTS$ + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISNIL() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * NOTE: Intentionally using a different method + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISNIL( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISCHAR() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISCHAR( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISNUM() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISNUM( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISLOG() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISLOG( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISDATE() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISDATE( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISMEMO() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISMEMO( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISBYREF() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * NOTE: Intentionally using a different method + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISBYREF( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISARRAY() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISARRAY( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISBLOCK() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Not available in CA-Cl*pper. + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISBLOCK( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ISPOINTER() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * Not available in CA-Cl*pper. + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ISPOINTER( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_pcount() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_pcount( ) --> item.asSymbol.paramcnt )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_ret() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_ret( ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_reta() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_reta( ulLen ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retc() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retc( szText ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retclen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retclen( szText, ulLen ) --> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retds() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retds( szDate ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retd( lYear, lMonth, lDay ) --> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retdl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retdl( lJulian ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retl( iLogical ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnd() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retnd( dNumber ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retni() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retni( iNumber ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnl() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retnl( lNumber ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnlen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retnlen( dNumber, iWidth, iDec ) --> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retndlen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retndlen( dNumber, iWidth, iDec ) --> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnilen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retnilen( iNumber, iWidth ) --> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_retnllen() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_retnllen( lNumber, iWidth ) --> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: HB_API_MACROS + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xmemcpy() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * hb_xmemcpy --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: UINT_MAX == ULONG_MAX + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * memcpy() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_xmemset() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * hb_xmemset --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * Conditional on: UINT_MAX == ULONG_MAX + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * memset() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_ISSPACE() + * $CATEGORY$ + * Extend API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_ISSPACE( c ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapi.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apier.txt b/harbour/doc/en/hb_apier.txt new file mode 100644 index 0000000000..7c9caf7ab4 --- /dev/null +++ b/harbour/doc/en/hb_apier.txt @@ -0,0 +1,1377 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Antonio Linares + * Header file for the Error API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetDescription() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetDescription( PHB_ITEM pError ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetFileName() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetFileName( PHB_ITEM pError ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetFlags() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetFlags( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetGenCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetGenCode( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetOperation() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetOperation( PHB_ITEM pError ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetOsCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetOsCode( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetSeverity() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetSeverity( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetSubCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetSubCode( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetSubSystem() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetSubSystem( PHB_ITEM pError ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errGetTries() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errGetTries( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errLaunch() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errLaunch( PHB_ITEM pError ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errNew() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errNew( void ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutArgs() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutArgs( PHB_ITEM pError, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutDescription() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutDescription( PHB_ITEM pError, char * szDescription ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutFileName() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutFileName( PHB_ITEM pError, char * szFileName ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutFlags() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutFlags( PHB_ITEM pError, USHORT uiFlags ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutGenCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutGenCode( PHB_ITEM pError, USHORT uiGenCode ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutOperation() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutOperation( PHB_ITEM pError, char * szOperation ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutOsCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutOsCode( PHB_ITEM pError, USHORT uiOsCode ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutSeverity() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutSeverity( PHB_ITEM pError, USHORT uiSeverity ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutSubCode() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutSubCode( PHB_ITEM pError, USHORT uiSubCode ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutSubSystem() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutSubSystem( PHB_ITEM pError, char * szSubSystem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errPutTries() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errPutTries( PHB_ITEM pError, USHORT uiTries ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRelease() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRelease( PHB_ITEM pError ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errInit() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errInit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errExit() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errExit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errLaunchSubst() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errLaunchSubst( PHB_ITEM pError ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_New() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_New( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_New_Subst() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_New_Subst( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_BASE() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_BASE( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_BASE_Ext1() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_BASE_Ext1( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_BASE_Subst() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_BASE_Subst( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_BASE_SubstR() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_BASE_SubstR( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_TERM() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_TERM( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOSCode, USHORT uiFlags ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_DBCMD() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_DBCMD( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errRT_TOOLS() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errRT_TOOLS( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errInternal() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errInternal( ULONG ulIntCode, char * szText, char * szPar1, char * szPar2 ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_errorHandler() + * $CATEGORY$ + * Error API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_errorHandler( HB_ERROR_INFO_PTR pNewHandler ) --> ( HB_ERROR_INFO_PTR )hParam + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apifs.txt b/harbour/doc/en/hb_apifs.txt new file mode 100644 index 0000000000..ec9963c5dc --- /dev/null +++ b/harbour/doc/en/hb_apifs.txt @@ -0,0 +1,1302 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 David G. Holm + * Header file for the Filesys API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsChDir() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Change working directory + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsChDir( BYTE * pszDirName ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsChDrv() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Change working drive + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsChDrv( BYTE nDrive ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsClose() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Close a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsClose( FHANDLE hFileHandle ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCommit() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Commit updates of a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCommit( FHANDLE hFileHandle ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCreate() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Create a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCreate( BYTE * pszFileName, USHORT uiAttribute ) --> ( FHANDLE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCreateTemp() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Create a temporary file from components + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCreateTemp( const BYTE * pszDir, const BYTE * pszPrefix, USHORT uiAttribute ) --> ( FHANDLE )hResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCurDir() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Retrieve a static pointer containing current directory for specified drive + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCurDir( USHORT uiDrive ) --> ( BYTE * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCurDirBuff() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Copy current directory for given drive into a buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCurDirBuff( USHORT uiDrive, BYTE * pbyBuffer, ULONG ulLen ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsCurDrv() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Retrieve current drive number + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsCurDrv( void ) --> ( BYTE )cResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsDelete() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Delete a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsDelete( BYTE * pszFileName ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsEof() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Determine if an open file is position at end-of-file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsEof( FHANDLE hFileHandle ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsError() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Retrieve file system error + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsError( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFile() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Determine if a file exists + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsFile( BYTE * pszFileName ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFSize() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Determine the size of a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsFSize( BYTE * pszFileName, BOOL bUseDirEntry ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsExtOpen() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Open a file using default extension and a list of paths + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsExtOpen( BYTE * pszFileName, BYTE * pDefExt, USHORT uiFlags, BYTE * pPaths, PHB_ITEM pError ) --> ( FHANDLE )hResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsIsDrv() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Determine if a drive number is a valid drive + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsIsDrv( BYTE nDrive ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsIsDevice() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Determine if a file is attached to a device (console?) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsIsDevice( FHANDLE hFileHandle ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsLock() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Request a lock on a portion of a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsLock( FHANDLE hFileHandle, ULONG ulStart, ULONG ulLength, USHORT uiMode ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsMkDir() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Create a directory + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsMkDir( BYTE * pszDirName ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsOpen() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Open a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsOpen( BYTE * pszFileName, USHORT uiFlags ) --> ( FHANDLE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsRead() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Read contents of a file into a buffer (<=64K) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsRead( FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsReadLarge() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Read contents of a file into a buffer (>64K) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsReadLarge( FHANDLE hFileHandle, BYTE * pBuff, ULONG ulCount ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsRmDir() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Remove a directory + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsRmDir( BYTE * pszDirName ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsRename() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Rename a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsRename( BYTE * pszOldName, BYTE * pszNewName ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsSeek() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Reposition an open file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsSeek( FHANDLE hFileHandle, LONG lOffset, USHORT uiMode ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsTell() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Retrieve the current position of a file + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsTell( FHANDLE hFileHandle ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsTempName() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Create a temporary file name in a buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsTempName( BYTE * pszBuffer, const BYTE * pszDir, const BYTE * pszPrefix ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsSetDevMode() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Change the device mode of a file (text/binary) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsSetDevMode( FHANDLE hFileHandle, USHORT uiDevMode ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsSetDevRaw() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Change the device mode of a file to raw (binary) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsSetDevRaw( FHANDLE hFileHandle ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsSetDevText() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Change the device mode of a file to text + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsSetDevText( FHANDLE hFileHandle ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsSetError() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Set the file system error number + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsSetError( USHORT uiError ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsWrite() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Write to an open file from a buffer (<=64K) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsWrite( FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsWriteLarge() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Write to an open file from a buffer (>64K) + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsWriteLarge( FHANDLE hFileHandle, BYTE * pBuff, ULONG ulCount ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFNameSplit() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * Split given filename into path, name and extension + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsFNameSplit( char * pszFileName ) --> ( PHB_FNAME )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFNameMerge() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * This function joins path, name and extension into a string with a filename + * $SYNTAX$ + * C Prototype + * + * #include + * hb_fsFNameMerge( char * pszFileName, PHB_FNAME pFileName ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFLock() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_fsFLock( h, s, l ) --> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapifs.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_fsFUnlock() + * $CATEGORY$ + * FileSys API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * hb_fsFUnlock( h, s, l ) --> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapifs.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apigt.txt b/harbour/doc/en/hb_apigt.txt new file mode 100644 index 0000000000..0dec1017ba --- /dev/null +++ b/harbour/doc/en/hb_apigt.txt @@ -0,0 +1,4326 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 {list of individual authors and e-mail addresses} + * Header file for the Terminal API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtInit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtInit( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtExit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtExit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtAdjustPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtAdjustPos( int iHandle, char * pStr, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtBox() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtBox( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtBoxD() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtBoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtBoxS() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtBoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtColorSelect() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtColorSelect( USHORT uiColorIndex ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtDispBegin() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtDispBegin( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtDispCount() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtDispCount( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtDispEnd() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtDispEnd( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtDrawShadow() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtDrawShadow( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtGetBlink() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtGetBlink( BOOL * pbBlink ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtGetColorStr() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtGetColorStr( char * pszColorString ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtGetCursor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtGetCursor( USHORT * puiCursorShape ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtGetPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtGetPos( SHORT * piRow, SHORT * piCol ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtIsColor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtIsColor( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtMaxCol() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtMaxCol( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtMaxRow() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtMaxRow( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtPostExt() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtPostExt( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtPreExt() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtPreExt( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSuspend() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Prepare the reminal for shell output + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSuspend( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtResume() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Resume the terminal after the shell output + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtResume( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtReadKey() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtReadKey( HB_inkey_enum eventmask ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtRectSize() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtRectSize( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, USHORT * puiBuffSize ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtRepChar() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtRepChar( USHORT uiRow, USHORT uiCol, BYTE byChar, USHORT uiCount ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtRest() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtRest( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSave() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSave( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtScrDim() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtScrDim( USHORT * puiHeight, USHORT * puiWidth ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtScroll() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtScroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, SHORT iRows, SHORT iCols ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetBlink() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetBlink( BOOL bBlink ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetColorStr() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetColorStr( char * pszColorString ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetCursor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetCursor( USHORT uiCursorShape ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetMode() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetMode( USHORT uiRows, USHORT uiCols ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetPos( SHORT iRow, SHORT iCol ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetPosContext() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetPosContext( SHORT iRow, SHORT iCol, SHORT iMode ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetSnowFlag() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetSnowFlag( BOOL bNoSnow ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtTone() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtTone( double dFrequency, double dDuration ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWrite() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWrite( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWriteAt() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWriteAt( USHORT uiRow, USHORT uiCol, BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWriteCon() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWriteCon( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtVersion() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtVersion( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWCreate() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWCreate( HB_GT_RECT * rect, HB_GT_WND ** wnd ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWDestroy() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWDestroy( HB_GT_WND * wnd ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWFlash() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWFlash( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWApp() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWApp( HB_GT_WND ** wnd ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWCurrent() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWCurrent( HB_GT_WND * wnd ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWPos( HB_GT_WND * wnd, HB_GT_RECT * rect ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtWVis() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtWVis( HB_GT_WND * wnd, USHORT uiStatus ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSLR() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * System Level Request + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSLR( HB_GT_SLR * pSLR ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtModalRead() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtModalRead( void * ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtBeginWrite() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtBeginWrite( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtEndWrite() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtEndWrite( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtFlushCursor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtFlushCursor( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetColor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetColor( HB_GT_RGB * color ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtGetColor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtGetColor( HB_GT_RGB * color ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gtSetBorder() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gtSetBorder( HB_GT_RGB * color ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Init() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Init( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Exit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Exit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_AdjustPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_AdjustPos( BYTE * pStr, ULONG ulLen ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Box() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Box( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_BoxD() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_BoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_BoxS() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_BoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Col() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Col( void ) --> ( SHORT )sResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_DispBegin() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_DispBegin( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_DispCount() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_DispCount( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_DispEnd() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_DispEnd( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_GetBlink() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_GetBlink( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_GetCursorStyle() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_GetCursorStyle( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_GetScreenHeight() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_GetScreenHeight( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_GetScreenWidth() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_GetScreenWidth( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_GetText() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_GetText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyDst ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_HorizLine() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_HorizLine( USHORT uiRow, USHORT uiLeft, USHORT uiRight, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_IsColor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_IsColor( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_PreExt() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_PreExt( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_PostExt() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_PostExt( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Suspend() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Suspend the terminal before the shell call + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Suspend( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Resume() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Resume the terminal after the shell call + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Resume( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Puts() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Puts( USHORT uiRow, USHORT uiCol, BYTE byAttr, BYTE * pbyStr, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_PutText() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_PutText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbySrc ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_ReadKey() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_ReadKey( HB_inkey_enum eventmask ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_RectSize() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_RectSize( USHORT rows, USHORT cols ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Replicate() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Replicate( USHORT uiTop, USHORT uiLeft, BYTE byAttr, BYTE byChar, ULONG ulLen ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Row() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Row( void ) --> ( SHORT )sResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Scroll() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Scroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr, SHORT iRows, SHORT iCols ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_SetAttribute() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_SetAttribute( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_SetBlink() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_SetBlink( BOOL bBlink ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_SetCursorStyle() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_SetCursorStyle( USHORT uiCursorShape ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_SetMode() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_SetMode( USHORT uiRows, USHORT uiCols ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_SetPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_SetPos( SHORT iRow, SHORT iCol, SHORT iMethod ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Tone() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Tone( double dFrequency, double dDuration ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_Version() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_Version( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_gt_VertLine() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_gt_VertLine( USHORT uiCol, USHORT uiTop, USHORT uiBottom, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkey() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Wait for keyboard input + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkey( BOOL bWait, double dSeconds, HB_inkey_enum event_mask ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyGet() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Extract the next key from the Harbour keyboard buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyGet( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyPut() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Inserts an inkey code into the keyboard buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyPut( int ch ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyLast() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Return the value of the last key that was extracted + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyLast( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyNext() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Return the next key without extracting it + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyNext( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyPoll() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Poll the console keyboard to stuff the Harbour buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyPoll( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_inkeyReset() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * Reset the Harbour keyboard buffer + * $SYNTAX$ + * C Prototype + * + * #include + * hb_inkeyReset( BOOL allocate ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseIsPresent() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseIsPresent( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseGetCursor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseGetCursor( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseSetCursor() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseSetCursor( BOOL bVisible ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseCol() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseCol( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseRow() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseRow( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseSetPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseSetPos( int iRow, int iCol ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseIsButtonPressed() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseIsButtonPressed( int iButton ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseCountButton() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseCountButton( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseSetBounds() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseSetBounds( int iTop, int iLeft, int iBottom, int iRight ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouseGetBounds() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouseGetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Init() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Init( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Exit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Exit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_IsPresent() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_IsPresent( void ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Show() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Show( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Hide() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Hide( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Col() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Col( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_Row() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_Row( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_SetPos() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_SetPos( int iRow, int iCol ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_IsButtonPressed() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_IsButtonPressed( int iButton ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_CountButton() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_CountButton( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_SetBounds() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_SetBounds( int iTop, int iLeft, int iBottom, int iRight ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_mouse_GetBounds() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_mouse_GetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_setkeyInit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_setkeyInit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_setkeyExit() + * $CATEGORY$ + * Terminal API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_setkeyExit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is gt* (ie. gtdos) + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apiit.txt b/harbour/doc/en/hb_apiit.txt new file mode 100644 index 0000000000..fe9a30479e --- /dev/null +++ b/harbour/doc/en/hb_apiit.txt @@ -0,0 +1,2033 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Antonio Linares + * Header file for the Item API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_evalLaunch() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_evalLaunch( PEVALINFO pEvalInfo ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_evalNew() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_evalNew( PEVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_evalPutParam() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_evalPutParam( PEVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_evalRelease() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_evalRelease( PEVALINFO pEvalInfo ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemDo() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemDo( PHB_ITEM pItem, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemDoC() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemDoC( char * szFunc, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemArrayGet() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemArrayGet( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemArrayNew() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemArrayNew( ULONG ulLen ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemArrayPut() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemArrayPut( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemCopyC() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemCopyC( PHB_ITEM pItem, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemFreeC() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemFreeC( char * szText ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetC() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetC( PHB_ITEM pItem ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetCPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetCPtr( PHB_ITEM pItem ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetCLen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetCLen( PHB_ITEM pItem ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetDS() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetDS( PHB_ITEM pItem, char * szDate ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetDL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetDL( PHB_ITEM pItem ) --> ( long )lResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetL( PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetND() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetND( PHB_ITEM pItem ) --> ( double )dResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetNI() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetNI( PHB_ITEM pItem ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetNL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetNL( PHB_ITEM pItem ) --> ( long )lResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetNLen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetNLen( PHB_ITEM pItem, int * piWidth, int * piDec ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemGetPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemGetPtr( PHB_ITEM pItem ) --> ( void * )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemNew() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemNew( PHB_ITEM pNull ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemInit() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemInit( PHB_ITEM pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPCount() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPCount( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemParam() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemParam( USHORT uiParam ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutC() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutC( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutCPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutCPtr( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutCL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutCL( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemSetCMemo() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemSetCMemo( PHB_ITEM pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutD() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutD( PHB_ITEM pItem, long lYear, long lMonth, long lDay ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutDS() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutDS( PHB_ITEM pItem, char * szDate ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutDL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutDL( PHB_ITEM pItem, long lJulian ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutL( PHB_ITEM pItem, BOOL bValue ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutND() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutND( PHB_ITEM pItem, double dNumber ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNI() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNI( PHB_ITEM pItem, int iNumber ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNL() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNL( PHB_ITEM pItem, long lNumber ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNLen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNDLen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNDLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNILen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNILen( PHB_ITEM pItem, int iNumber, int iWidth ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutNLLen() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutNLLen( PHB_ITEM pItem, long lNumber, int iWidth ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPutPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPutPtr( PHB_ITEM pItem, void * pValue ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemRelease() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemRelease( PHB_ITEM pItem ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemReturn() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemReturn( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemSize() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemSize( PHB_ITEM pItem ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemType() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemType( PHB_ITEM pItem ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemTypeStr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemTypeStr( PHB_ITEM pItem ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemParamPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemParamPtr( USHORT uiParam, int iMask ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemReturnPtr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemReturnPtr( void ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemStrCmp() + * $CATEGORY$ + * Item API + * $ONELINER$ + * Our string compare + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemStrCmp( PHB_ITEM pFirst, PHB_ITEM pSecond, BOOL bForceExact ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemCopy() + * $CATEGORY$ + * Item API + * $ONELINER$ + * Copies an item to one place to another respecting its containts + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemCopy( PHB_ITEM pDest, PHB_ITEM pSource ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemClear() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemClear( PHB_ITEM pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemUnRef() + * $CATEGORY$ + * Item API + * $ONELINER$ + * De-references passed variable + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemUnRef( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemStr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * Convert a number to a string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemStr( PHB_ITEM pNumber, PHB_ITEM pWidth, PHB_ITEM pDec ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemString() + * $CATEGORY$ + * Item API + * $ONELINER$ + * Convert any scalar to a string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemString( PHB_ITEM pItem, ULONG * ulLen, BOOL * bFreeReq ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemValToStr() + * $CATEGORY$ + * Item API + * $ONELINER$ + * Convert any scalar to a string + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemValToStr( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemPadConv() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemPadConv( PHB_ITEM pItem, char * buffer, ULONG * pulSize ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_itemSwap() + * $CATEGORY$ + * Item API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_itemSwap( PHB_ITEM pItem1, PHB_ITEM pItem2 ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apiln.txt b/harbour/doc/en/hb_apiln.txt new file mode 100644 index 0000000000..d70dd6ebc8 --- /dev/null +++ b/harbour/doc/en/hb_apiln.txt @@ -0,0 +1,345 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Victor Szakats + * Header file for the Language API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langRegister() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langRegister( PHB_LANG lang ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langDeRegister() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langDeRegister( char * pszID ) --> ( BOOL )bResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langFind() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langFind( char * pszID ) --> ( PHB_LANG )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langSelect() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langSelect( PHB_LANG lang ) --> ( PHB_LANG )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langSelectID() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langSelectID( char * pszID ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langDGetItem() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langDGetItem( int iIndex ) --> ( void * )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langID() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langID( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langName() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langName( void ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_langDGetErrorDesc() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_langDGetErrorDesc( ULONG ulIndex ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is lang + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * HB_LANG_REQUEST() + * $CATEGORY$ + * Language API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * HB_LANG_REQUEST( id ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapilng.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_apird.txt b/harbour/doc/en/hb_apird.txt new file mode 100644 index 0000000000..c606df7cfe --- /dev/null +++ b/harbour/doc/en/hb_apird.txt @@ -0,0 +1,7901 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 {list of individual authors and e-mail addresses} + * Header file for the RDD API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddGetCurrentWorkAreaNumber() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddGetCurrentWorkAreaNumber( void ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddGetCurrentWorkAreaPointer() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddGetCurrentWorkAreaPointer( void ) --> ( void * )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddSelectWorkAreaAlias() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddSelectWorkAreaAlias( char * szAlias ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddSelectWorkAreaNumber() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddSelectWorkAreaNumber( int iArea ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddSelectWorkAreaSymbol() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddSelectWorkAreaSymbol( PHB_SYMB pSymAlias ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddGetFieldValue() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddGetFieldValue( HB_ITEM_PTR pItem, PHB_SYMB pFieldSymbol ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddPutFieldValue() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddPutFieldValue( HB_ITEM_PTR pItem, PHB_SYMB pFieldSymbol ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddFieldGet() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddFieldGet( HB_ITEM_PTR pItem, PHB_SYMB pFieldSymbol ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddFieldPut() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddFieldPut( HB_ITEM_PTR pItem, PHB_SYMB pFieldSymbol ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddShutDown() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddShutDown( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddInherit() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddInherit( PRDDFUNCS pTable, PRDDFUNCS pSubTable, PRDDFUNCS pSuperTable, BYTE * szDrvName ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddDisinherit() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddDisinherit( BYTE * drvName ) --> ( ERRCODE )hResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddExtendType() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddExtendType( USHORT fieldType ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_rddFieldType() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_rddFieldType( USHORT extendType ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rdd, nulsys, dbfntx, dbfcdx + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_BOF() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_BOF( w, sp ) --> lprfsHost->bof )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_EOF() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_EOF( w, sp ) --> lprfsHost->eof )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FOUND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FOUND( w, sp ) --> lprfsHost->found )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOTO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOTO( w, l ) --> lprfsHost->go )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOTOID() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOTOID( w, sp ) --> lprfsHost->goToId )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOBOTTOM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOBOTTOM( w ) --> lprfsHost->goBottom )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOTOP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOTOP( w ) --> lprfsHost->goTop )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SEEK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SEEK( w, i1, v, i2 ) --> lprfsHost->seek )( w, i1, v, i2 ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SKIP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SKIP( w, l ) --> lprfsHost->skip )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SKIPFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SKIPFILTER( w, l ) --> lprfsHost->skipFilter )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SKIPRAW() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SKIPRAW( w, l ) --> lprfsHost->skipRaw )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ADDFIELD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ADDFIELD( w, ip ) --> lprfsHost->addField )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_APPEND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_APPEND( w, l ) --> lprfsHost->append )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CREATEFIELDS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CREATEFIELDS( w, v ) --> lprfsHost->createFields )( w, v ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_DELETE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_DELETE( w ) --> lprfsHost->deleterec )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_DELETED() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_DELETED( w, sp ) --> lprfsHost->deleted )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FIELDCOUNT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FIELDCOUNT( w, sp ) --> lprfsHost->fieldCount )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FIELDDISPLAY() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FIELDDISPLAY( w, sp ) --> lprfsHost->fieldDisplay )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FIELDINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FIELDINFO( w, s1, s2, v ) --> lprfsHost->fieldInfo )( w, s1, s2, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FIELDNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FIELDNAME( w, i, bp ) --> lprfsHost->fieldName )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FLUSH() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FLUSH( w ) --> lprfsHost->flush )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETREC( w, bpp ) --> lprfsHost->getRec )( w, bpp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETVALUE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETVALUE( w, i, v ) --> lprfsHost->getValue )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETVARLEN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETVARLEN( w, i, lp ) --> lprfsHost->getVarLen )( w, i, lp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOCOLD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOCOLD( w ) --> lprfsHost->goCold )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GOHOT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GOHOT( w ) --> lprfsHost->goHot )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_PUTVALUE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_PUTVALUE( w, i, v ) --> lprfsHost->putValue )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_PUTREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_PUTREC( w, bp ) --> lprfsHost->putRec )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RECALL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RECALL( w ) --> lprfsHost->recall )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RECCOUNT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RECCOUNT( w, sp ) --> lprfsHost->reccount )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RECINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RECINFO( w, v1, i, v2 ) --> lprfsHost->recInfo )( w, v1, i, v2 ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RECNO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RECNO( w, i ) --> lprfsHost->recno )( w, i ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETFIELDEXTENT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETFIELDEXTENT( w, s ) --> lprfsHost->setFieldExtent )( w, s ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ALIAS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ALIAS( w, bp ) --> lprfsHost->alias )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLOSE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLOSE( w ) --> lprfsHost->close )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CREATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CREATE( w, ip ) --> lprfsHost->create )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_INFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_INFO( w, i, g ) --> lprfsHost->info )( w, i, g ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_NEW() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_NEW( w ) --> lprfsHost->newarea )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_OPEN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_OPEN( w, ip ) --> lprfsHost->open )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RELEASE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RELEASE( w ) --> lprfsHost->release )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_STRUCTSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_STRUCTSIZE( w, sp ) --> lprfsHost->structSize )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SYSNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SYSNAME( w, bp ) --> lprfsHost->sysName )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_DBEVAL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_DBEVAL( w, ip ) --> lprfsHost->dbEval )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_PACK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_PACK( w ) --> lprfsHost->pack )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_PACKREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_PACKREC( w, l, sp ) --> lprfsHost->packRec )( w, l, sp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SORT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SORT( w, ip ) --> lprfsHost->sort )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_TRANS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_TRANS( w, ip ) --> lprfsHost->trans )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_TRANSREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_TRANSREC( w, ip ) --> lprfsHost->transRec )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ZAP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ZAP( w ) --> lprfsHost->zap )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CHILDEND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CHILDEND( w, ip ) --> lprfsHost->childEnd )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CHILDSTART() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CHILDSTART( w, ip ) --> lprfsHost->childStart )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CHILDSYNC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CHILDSYNC( w, ip ) --> lprfsHost->childSync )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SYNCCHILDREN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SYNCCHILDREN( w ) --> lprfsHost->syncChildren )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLEARREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLEARREL( w ) --> lprfsHost->clearRel )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FORCEREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FORCEREL( w ) --> lprfsHost->forceRel )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RELAREA() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RELAREA( w, s, sp ) --> lprfsHost->relArea )( w, s, sp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RELEVAL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RELEVAL( w, ip ) --> lprfsHost->relEval )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RELTEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RELTEXT( w, s, bp ) --> lprfsHost->relText )( w, s, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETREL( w, ip ) --> lprfsHost->setRel )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDLSTADD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDLSTADD( w, lp ) --> lprfsHost->orderListAdd )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDLSTDELETE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDLSTDELETE( w, lp ) --> lprfsHost->orderListDelete )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDLSTFOCUS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDLSTFOCUS( w, lp ) --> lprfsHost->orderListFocus )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDLSTREBUILD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDLSTREBUILD( w ) --> lprfsHost->orderListRebuild )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDLSTCLEAR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDLSTCLEAR( w ) --> lprfsHost->orderListClear )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDSETCOND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDSETCOND( w, ip ) --> lprfsHost->orderCondition )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDCREATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDCREATE( w, ip ) --> lprfsHost->orderCreate )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDDESTROY() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDDESTROY( w, p ) --> lprfsHost->orderDestroy )( w, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDINFO( w, i, p ) --> lprfsHost->orderInfo )( w, i, p ) )> + * $ARGUMENTS$ + * + * + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDEXPR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDEXPR( w, p ) --> lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDCOND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDCOND( w, p ) --> lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDRECNO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDRECNO( w, p ) --> lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDPOS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDPOS( w, p ) --> lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDNUMBER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDNUMBER( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NAME, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDBAGNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDBAGNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ORDBAGEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ORDBAGEXT( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLEARFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLEARFILTER( w ) --> lprfsHost->clearFilter )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLEARLOCATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLEARLOCATE( w ) --> lprfsHost->clearLocate )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLEARSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLEARSCOPE( w ) --> lprfsHost->clearScope )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_COUNTSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_COUNTSCOPE( w, ip, lp ) --> lprfsHost->countScope )( w, ip, lp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_FILTERTEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_FILTERTEXT( w, bp ) --> lprfsHost->filterText )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SCOPEINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SCOPEINFO( w, i, v ) --> lprfsHost->scopeInfo )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETFILTER( w, ip ) --> lprfsHost->setFilter )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETLOCATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETLOCATE( w, ip ) --> lprfsHost->setLocate )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETSCOPE( w, ip ) --> lprfsHost->setScope )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SKIPSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SKIPSCOPE( w, bp, l ) --> lprfsHost->skipScope )( w, bp, l ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_COMPILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_COMPILE( w, bp ) --> lprfsHost->compile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_ERROR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_ERROR( w, ip ) --> lprfsHost->error )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_EVALBLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_EVALBLOCK( w, v ) --> lprfsHost->evalBlock )( w, v ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETLOCKS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETLOCKS( w, g ) --> lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RAWLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RAWLOCK( w, i, l ) --> lprfsHost->rawlock )( w, i, l ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_LOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_LOCK( w, sp ) --> lprfsHost->lock )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_UNLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_UNLOCK( w, l ) --> lprfsHost->unlock )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CLOSEMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CLOSEMEMFILE( w ) --> lprfsHost->closeMemFile )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_CREATEMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_CREATEMEMFILE( w, bp ) --> lprfsHost->createMemFile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETVALUEFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETVALUEFILE( w, i, bp ) --> lprfsHost->getValueFile )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_OPENMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_OPENMEMFILE( w, bp ) --> lprfsHost->openMemFile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_PUTVALUEFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_PUTVALUEFILE( w, i, bp ) --> lprfsHost->putValueFile )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_READDBHEADER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_READDBHEADER( w ) --> lprfsHost->readDBHeader )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_WRITEDBHEADER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_WRITEDBHEADER( w ) --> lprfsHost->writeDBHeader )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_RECSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_RECSIZE( w, lp ) --> lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_HEADERSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_HEADERSIZE( w, fp ) --> lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_LUPDATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_LUPDATE( w, fp ) --> lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_SETDELIM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_SETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_GETDELIM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_GETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SELF_TABLEEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SELF_TABLEEXT( w, fp ) --> lprfsHost->info )( w, DBI_TABLEEXT, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_BOF() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_BOF( w, sp ) --> bof )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_EOF() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_EOF( w, sp ) --> eof )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FOUND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FOUND( w, sp ) --> found )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOTO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOTO( w, l ) --> go )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOTOID() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOTOID( w, sp ) --> goToId )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOBOTTOM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOBOTTOM( w ) --> goBottom )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOTOP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOTOP( w ) --> goTop )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SEEK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SEEK( w, i1, v, i2 ) --> seek )( w, i1, v, i2 ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SKIP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SKIP( w, l ) --> skip )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SKIPFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SKIPFILTER( w, l ) --> skipFilter )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SKIPRAW() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SKIPRAW( w, l ) --> skipRaw )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ADDFIELD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ADDFIELD( w, ip ) --> addField )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_APPEND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_APPEND( w, l ) --> append )( w, l ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CREATEFIELDS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CREATEFIELDS( w, v ) --> createFields )( w, v ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_DELETE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_DELETE( w ) --> deleterec )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_DELETED() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_DELETED( w, sp ) --> deleted )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FIELDCOUNT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FIELDCOUNT( w, sp ) --> fieldCount )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FIELDDISPLAY() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FIELDDISPLAY( w, sp ) --> fieldDisplay )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FIELDINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FIELDINFO( w, s1, s2, v ) --> fieldInfo )( w, s1, s2, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FIELDNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FIELDNAME( w, i, bp ) --> fieldName )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FLUSH() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FLUSH( w ) --> flush )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETREC( w, bpp ) --> getRec )( w, bpp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETVALUE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETVALUE( w, i, v ) --> getValue )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETVARLEN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETVARLEN( w, i, lp ) --> getVarLen )( w, i, lp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOCOLD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOCOLD( w ) --> goCold )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GOHOT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GOHOT( w ) --> goHot )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_PUTVALUE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_PUTVALUE( w, i, v ) --> putValue )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_PUTREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_PUTREC( w, bp ) --> putRec )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RECALL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RECALL( w ) --> recall )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RECCOUNT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RECCOUNT( w, sp ) --> reccount )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RECINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RECINFO( w, v1, i, v2 ) --> recInfo )( w, v1, i, v2 ) )> + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RECNO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RECNO( w, sp ) --> recno )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETFIELDEXTENT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETFIELDEXTENT( w, s ) --> setFieldExtent )( w, s ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ALIAS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ALIAS( w, bp ) --> alias )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLOSE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLOSE( w ) --> close )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CREATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CREATE( w, ip ) --> create )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_INFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_INFO( w, i, g ) --> info )( w, i, g ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_NEW() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_NEW( w ) --> newarea )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_OPEN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_OPEN( w, ip ) --> open )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RELEASE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RELEASE( w ) --> release )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_STRUCTSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_STRUCTSIZE( w, sp ) --> structSize )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SYSNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SYSNAME( w, bp ) --> sysName )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_DBEVAL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_DBEVAL( w, ip ) --> dbEval )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_PACK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_PACK( w ) --> pack )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_PACKREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_PACKREC( w, l, sp ) --> packRec )( w, l, sp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SORT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SORT( w, ip ) --> sort )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_TRANS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_TRANS( w, ip ) --> trans )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_TRANSREC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_TRANSREC( w, ip ) --> transRec )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ZAP() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ZAP( w ) --> zap )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CHILDEND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CHILDEND( w, ip ) --> childEnd )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CHILDSTART() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CHILDSTART( w, ip ) --> childStart )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CHILDSYNC() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CHILDSYNC( w, ip ) --> childSync )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SYNCCHILDREN() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SYNCCHILDREN( w ) --> syncChildren )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLEARREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLEARREL( w ) --> clearRel )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FORCEREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FORCEREL( w ) --> forceRel )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RELAREA() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RELAREA( w, s, sp ) --> relArea )( w, s, sp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RELEVAL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RELEVAL( w, ip ) --> relEval )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RELTEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RELTEXT( w, s, bp ) --> relText )( w, s, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETREL() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETREL( w, ip ) --> setRel )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDLSTADD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDLSTADD( w, lp ) --> orderListAdd )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDLSTDELETE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDLSTDELETE( w, lp ) --> orderListDelete )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDLSTFOCUS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDLSTFOCUS( w, lp ) --> orderListFocus )( w, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDLSTREBUILD() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDLSTREBUILD( w ) --> orderListRebuild )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDLSTCLEAR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDLSTCLEAR( w ) --> orderListClear )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDSETCOND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDSETCOND( w, ip ) --> orderCondition )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDCREATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDCREATE( w, ip ) --> orderCreate )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDDELETE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDDELETE( w, ip ) --> orderDelete )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDINFO( w, i, p ) --> orderInfo )( w, i, p ) )> + * $ARGUMENTS$ + * + * + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDEXPR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDEXPR( w, p ) --> orderInfo )( w, DBOI_EXPRESSION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDCOND() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDCOND( w, p ) --> orderInfo )( w, DBOI_CONDITION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDRECNO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDRECNO( w, p ) --> orderInfo )( w, DBOI_RECNO, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDPOS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDPOS( w, p ) --> orderInfo )( w, DBOI_POSITION, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDNUMBER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDNUMBER( w, p ) --> orderInfo )( w, DBOI_NUMBER, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDNAME( w, p ) --> orderInfo )( w, DBOI_NAME, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDBAGNAME() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDBAGNAME( w, p ) --> orderInfo )( w, DBOI_BAGNAME, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ORDBAGEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ORDBAGEXT( w, p ) --> orderInfo )( w, DBOI_BAGEXT, p ) )> + * $ARGUMENTS$ + * + * + *

+ * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLEARFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLEARFILTER( w ) --> clearFilter )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLEARLOCATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLEARLOCATE( w ) --> clearLocate )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLEARSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLEARSCOPE( w ) --> clearScope )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_COUNTSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_COUNTSCOPE( w, ip, lp ) --> countScope )( w, ip, lp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_FILTERTEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_FILTERTEXT( w, bp ) --> filterText )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SCOPEINFO() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SCOPEINFO( w, i, v ) --> scopeInfo )( w, i, v ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETFILTER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETFILTER( w, ip ) --> setFilter )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETLOCATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETLOCATE( w, ip ) --> setLocate )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETSCOPE( w, ip ) --> setScope )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SKIPSCOPE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SKIPSCOPE( w, bp, l ) --> skipScope )( w, bp, l ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_COMPILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_COMPILE( w, bp ) --> compile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_ERROR() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_ERROR( w, ip ) --> error )( w, ip ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_EVALBLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_EVALBLOCK( w, v ) --> evalBlock )( w, v ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETLOCKS() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETLOCKS( w, g ) --> info )( w, DBI_GETLOCKARRAY, g ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RAWLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RAWLOCK( w, i, l ) --> rawlock )( w, i, l ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_LOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_LOCK( w, sp ) --> lock )( w, sp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_UNLOCK() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_UNLOCK( w ) --> unlock )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CLOSEMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CLOSEMEMFILE( w ) --> closeMemFile )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_CREATEMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_CREATEMEMFILE( w, bp ) --> createMemFile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETVALUEFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETVALUEFILE( w, i, bp ) --> getValueFile )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_OPENMEMFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_OPENMEMFILE( w, bp ) --> openMemFile )( w, bp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_PUTVALUEFILE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_PUTVALUEFILE( w, i, bp ) --> putValueFile )( w, i, bp ) )> + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_READDBHEADER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_READDBHEADER( w ) --> readDBHeader )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_WRITEDBHEADER() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_WRITEDBHEADER( w ) --> writeDBHeader )( w ) )> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_RECSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_RECSIZE( w, lp ) --> info )( w, DBI_GETRECSIZE, lp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_HEADERSIZE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_HEADERSIZE( w, fp ) --> info )( w, DBI_GETHEADERSIZE, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_LUPDATE() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_LUPDATE( w, fp ) --> info )( w, DBI_LASTUPDATE, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_SETDELIM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_SETDELIM( w, fp ) --> info )( w, DBI_SETDELIMITER, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_GETDELIM() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_GETDELIM( w, fp ) --> info )( w, DBI_GETDELIMITER, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SUPER_TABLEEXT() + * $CATEGORY$ + * RDD API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * SUPER_TABLEEXT( w, fp ) --> info )( w, DBI_TABLEEXT, fp ) )> + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is hbapirdd.h + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_compa.txt b/harbour/doc/en/hb_compa.txt new file mode 100644 index 0000000000..374d998595 --- /dev/null +++ b/harbour/doc/en/hb_compa.txt @@ -0,0 +1,5130 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Victor Szakats + * Compatibility header file for CA-Clipper Virtual Memory API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * _evalLaunch() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _evalLaunch --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_evalLaunch() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _evalNew() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _evalNew --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_evalNew() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _evalPutParam() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _evalPutParam --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_evalPutParam() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _evalRelease() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _evalRelease --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_evalRelease() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemArrayGet() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemArrayGet --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemArrayGet() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemArrayNew() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemArrayNew --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemArrayNew() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemArrayPut() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemArrayPut --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemArrayPut() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemNew() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemNew --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemNew() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemParam() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemParam --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemParam() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemRelease() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemRelease --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemRelease() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemReturn() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemReturn --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemReturn() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemSize() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemSize --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemSize() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _itemType() + * $CATEGORY$ + * Item compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _itemType --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is item.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_itemType() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _reta() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _reta --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_reta() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _pcount() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _pcount --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_pcount() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tchdir() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tchdir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsChDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tchdrv() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tchdrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsChDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tclose() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tclose --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsClose() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tcommit() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tcommit --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCommit() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tcreat() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tcreat --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCreate() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tcurdir() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tcurdir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCurDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tcurdrv() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tcurdrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCurDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tdevraw() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tdevraw --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsSetDevRaw() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _terror() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _terror --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsError() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tisdevice() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tisdevice --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsIsDevice() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tisdrv() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tisdrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsIsDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tlock() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tlock --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsLock() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tlseek() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tlseek --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsSeek() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tmkdir() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tmkdir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsMkDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _topen() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _topen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsOpen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tread() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tread --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRead() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _trename() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _trename --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRename() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _trmdir() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _trmdir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRmDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _tunlink() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _tunlink --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsDelete() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _twrite() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _twrite --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsWrite() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _bset() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _bset --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * memset() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _bmove() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _bmove --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * memmove() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _bcopy() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _bcopy --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * memcpy() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _bcmp() + * $CATEGORY$ + * Undocumented compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _bcmp --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is hbundoc.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * memcmp() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtBox() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtBox --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtBox() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtColorSelect() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtColorSelect --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtColorSelect() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtDispBegin() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtDispBegin --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtDispBegin() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtDispCount() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtDispCount --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtDispCount() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtDispEnd() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtDispEnd --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtDispEnd() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtGetColorStr() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtGetColorStr --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtGetColorStr() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtGetCursor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtGetCursor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtGetCursor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtGetPos() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtGetPos --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtGetPos() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtIsColor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtIsColor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtIsColor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtMaxCol() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtMaxCol --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtMaxCol() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtMaxRow() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtMaxRow --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtMaxRow() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtPostExt() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtPostExt --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtPostExt() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtPreExt() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtPreExt --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtPreExt() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtRectSize() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtRectSize --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtRectSize() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtRepChar() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtRepChar --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtRepChar() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtRest() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtRest --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtRest() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSave() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSave --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSave() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtScrDim() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtScrDim --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtScrDim() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtScroll() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtScroll --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtScroll() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetBlink() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetBlink --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetBlink() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetColorStr() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetColorStr --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetColorStr() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetCursor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetCursor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetCursor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetMode() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetMode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetMode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetPos() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetPos --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetPos() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetSnowFlag() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetSnowFlag --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetSnowFlag() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWrite() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWrite --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWrite() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWriteAt() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWriteAt --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWriteAt() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWriteCon() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWriteCon --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWriteCon() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtInit() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtInit --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtInit() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtExit() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtExit --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtExit() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWCreate() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWCreate --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWCreate() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWDestroy() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWDestroy --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWDestroy() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWFlash() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWFlash --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWFlash() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWApp() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWApp --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWApp() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWCurrent() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWCurrent --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWCurrent() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWPos() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWPos --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWPos() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtWVis() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtWVis --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtWVis() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtModalRead() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtModalRead --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtModalRead() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtBeginWrite() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtBeginWrite --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtBeginWrite() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtEndWrite() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtEndWrite --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtEndWrite() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtFlushCursor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtFlushCursor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtFlushCursor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetColor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetColor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetColor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtGetColor() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtGetColor --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtGetColor() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _gtSetBorder() + * $CATEGORY$ + * Terminal compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _gtSetBorder --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is gt.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_gtSetBorder() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _xalloc() + * $CATEGORY$ + * Fixed memory compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _xalloc --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is fm.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_xalloc() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _xgrab() + * $CATEGORY$ + * Fixed memory compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _xgrab --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is fm.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_xgrab() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _xfree() + * $CATEGORY$ + * Fixed memory compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _xfree --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is fm.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_xfree() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _exmgrab() + * $CATEGORY$ + * Fixed memory compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _exmgrab --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is fm.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_xgrab() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsChDir() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsChDir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsChDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsChDrv() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsChDrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsChDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsClose() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsClose --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsClose() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsCommit() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsCommit --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCommit() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsCreate() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsCreate --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCreate() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsCurDir() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsCurDir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCurDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsCurDrv() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsCurDrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsCurDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsDelete() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsDelete --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsDelete() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsError() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsError --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsError() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsExtOpen() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsExtOpen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsExtOpen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsIsDrv() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsIsDrv --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsIsDrv() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsLock() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsLock --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsLock() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsMkDir() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsMkDir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsMkDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsOpen() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsOpen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsOpen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsRead() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsRead --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRead() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsRmDir() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsRmDir --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRmDir() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsRename() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsRename --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsRename() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsSeek() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsSeek --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsSeek() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _fsWrite() + * $CATEGORY$ + * FileSys compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _fsWrite --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is filesys.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_fsWrite() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ALENGTH + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro definition) + * + * #include + * ALENGTH( n ) --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parc() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parc --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parc() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parclen() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parclen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parclen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parcsiz() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parcsiz --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parcsiz() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _pards() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _pards --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_pards() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parinfa() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parinfa --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parinfa() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parinfo() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parinfo --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parinfo() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parnd() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parnd --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parnd() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parni() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parni --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parni() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _parnl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _parnl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_parnl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _ret() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _ret --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_ret() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retc() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retc --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retc() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retclen() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retclen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retclen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retds() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retds --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retds() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retnd() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retnd --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retnd() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retni() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retni --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retni() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _retnl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _retnl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_retnl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _storc() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _storc --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_storc() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _storclen() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _storclen --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_storclen() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _stords() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _stords --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_stords() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _storl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _storl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_storl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _stornd() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _stornd --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_stornd() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _storni() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _storni --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_storni() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _stornl() + * $CATEGORY$ + * Extend compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _stornl --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is extend.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_stornl() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetDescription() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetDescription --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetDescription() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetFileName() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetFileName --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetFileName() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetFlags() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetFlags --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetFlags() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetGenCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetGenCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetGenCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetOperation() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetOperation --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetOperation() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetOsCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetOsCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetOsCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetSeverity() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetSeverity --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetSeverity() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetSubCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetSubCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetSubCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetSubSystem() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetSubSystem --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetSubSystem() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errGetTries() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errGetTries --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errGetTries() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errLaunch() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errLaunch --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errLaunch() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errNew() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errNew --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errNew() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutDescription() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutDescription --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutDescription() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutFileNaem() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutFileNaem --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutFileName() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutFlags() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutFlags --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutFlags() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutGenCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutGenCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutGenCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutOperation() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutOperation --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutOperation() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutOsCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutOsCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutOsCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutSeverity() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutSeverity --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutSeverity() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutSubCode() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutSubCode --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutSubCode() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutSubSystem() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutSubSystem --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutSubSystem() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errPutTries() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errPutTries --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errPutTries() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * _errRelease() + * $CATEGORY$ + * Error compatability API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype (macro replacement) + * + * #include + * _errRelease --> + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * + * $FILES$ + * Header file is error.api + * $PLATFORMS$ + * All + * $SEEALSO$ + * hb_errRelease() + * $END$ + */ + diff --git a/harbour/doc/en/hb_date.txt b/harbour/doc/en/hb_date.txt new file mode 100644 index 0000000000..83ddbfd9c5 --- /dev/null +++ b/harbour/doc/en/hb_date.txt @@ -0,0 +1,480 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Victor Szakats + * Header file for the Date API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateSeconds() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateSeconds( void ) --> ( double )dResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateToday() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateToday( long * plYear, long * plMonth, long * plDay ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateTimeStr() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateTimeStr( char * pszTime ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateCMonth() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateCMonth( int iMonth ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateCDOW() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateCDOW( int iDay ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateDOW() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateDOW( long lYear, long lMonth, long lDay ) --> ( long )lResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateFormat() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateFormat( const char * szDate, char * szFormattedDate, const char * szDateFormat ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateEncode() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateEncode( long lYear, long lMonth, long lDay ) --> ( long )lResult + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateDecode() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateDecode( long julian, long * plYear, long * plMonth, long * plDay ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateStrPut() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateStrPut( char * szDate, long lYear, long lMonth, long lDay ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateStrGet() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateStrGet( const char * szDate, long * plYear, long * plMonth, long * plDay ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateDecStr() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateDecStr( char * szDate, long lJulian ) --> ( char * )pszResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_dateEncStr() + * $CATEGORY$ + * Date API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_dateEncStr( char * szDate ) --> ( long )lResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_macro.txt b/harbour/doc/en/hb_macro.txt new file mode 100644 index 0000000000..e23417a0ad --- /dev/null +++ b/harbour/doc/en/hb_macro.txt @@ -0,0 +1,1062 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Ryszard Glab + * Header file for the Macro compiler + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_macroError() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_macroError( int iError, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compParse() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compParse( HB_MACRO_PTR pMacro ) --> ( int )iResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPCode1() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPCode1( BYTE byte, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPCode2() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPCode2( BYTE byte1, BYTE byte2, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPCode3() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPCode3( BYTE byte1, BYTE byte2, BYTE byte3, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPCode4() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPCode4( BYTE byte1, BYTE byte2, BYTE byte3, BYTE byte4, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPCodeN() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPCodeN( BYTE * pBuffer, ULONG ulSize, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compLocalVarGetPos() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compLocalVarGetPos( char * szVarName, HB_BISON_PTR pMacro ) --> ( int )iResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenJump() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenJump( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenJumpFalse() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenJumpFalse( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenJumpThere() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenJumpThere( ULONG ulFrom, ULONG ulTo, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenJumpHere() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenJumpHere( ULONG ulOffset, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenJumpTrue() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenJumpTrue( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compMemvarGenPCode() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compMemvarGenPCode( BYTE bPCode, char * szVarName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushSymbol() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushSymbol( char * szSymbolName, int isFunction, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushLong() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushLong( long lNumber, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenMessage() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenMessage( char * szMsgName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenMessageData() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenMessageData( char * szMsg, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPopVar() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPopVar( char * szVarName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPopAliasedVar() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPopAliasedVar( char * szVarName, BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushVar() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushVar( char * szVarName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushVarRef() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushVarRef( char * szVarName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushAliasedVar() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushAliasedVar( char * szVarName, BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushLogical() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushLogical( int iTrueFalse, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushDouble() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushDouble( double dNumber, BYTE bWidth, BYTE bDec, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushFunCall() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushFunCall( char * szFunName, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compGenPushString() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compGenPushString( char * szText, ULONG ulStrLen, HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compCodeBlockStart() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compCodeBlockStart( HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_compCodeBlockEnd() + * $CATEGORY$ + * Macro API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_compCodeBlockEnd( HB_BISON_PTR pMacro ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is macro + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_set.txt b/harbour/doc/en/hb_set.txt new file mode 100644 index 0000000000..5c54bcd46a --- /dev/null +++ b/harbour/doc/en/hb_set.txt @@ -0,0 +1,81 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 David G. Holm + * Header file for the Set API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_setInitialize() + * $CATEGORY$ + * Set API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_setInitialize( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_setRelease() + * $CATEGORY$ + * Set API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_setRelease( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is rtl + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + diff --git a/harbour/doc/en/hb_vm.txt b/harbour/doc/en/hb_vm.txt new file mode 100644 index 0000000000..78d242ef58 --- /dev/null +++ b/harbour/doc/en/hb_vm.txt @@ -0,0 +1,986 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Antonio Linares + * Header file for the Virtual Machine API + * + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmInit() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmInit( BOOL bStartMainProc ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmQuit() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Immediately quits the virtual machine + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmQuit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmExecute() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Invokes the virtual machine + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmExecute( const BYTE * pCode, PHB_SYMB pSymbols ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmProcessSymbols() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Statics symbols initialization + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmProcessSymbols( PHB_SYMB pSymbols, USHORT uiSymbols ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmSymbolInit_RT() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Initialization of runtime support symbols + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmSymbolInit_RT( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmRequestQuit() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmRequestQuit( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmRequestEndProc() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmRequestEndProc( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmRequestCancel() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmRequestCancel( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmRequestBreak() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmRequestBreak( PHB_ITEM pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmRequestQuery() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmRequestQuery( void ) --> ( USHORT )usResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmMessage() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Sends a message to an object + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmMessage( PHB_SYMB pSymMsg ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmDo() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Invoke the virtual machine + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmDo( USHORT uiParams ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmFunction() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Executes a function saving its result + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmFunction( USHORT uiParams ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmSend() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Sends a message to an object + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmSend( USHORT uiParams ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmEvalBlock() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Executes passed codeblock with no arguments + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmEvalBlock( PHB_ITEM pBlockItem ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmEvalBlockV() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmEvalBlockV( PHB_ITEM pBlockItem, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult + * $ARGUMENTS$ + * + * + * + * + * <...> + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPush() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a generic item onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPush( PHB_ITEM pItem ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushNil() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * In this case it places nil at self + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushNil( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushNumber() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a number on to the stack and decides if it is integer, long or double + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushNumber( double dNumber, int iDec ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushInteger() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a integer number onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushInteger( int iNumber ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushLong() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a long number onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushLong( long lNumber ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushDouble() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a double number onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushDouble( double lNumber, int iDec ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushLogical() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a logical value onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushLogical( BOOL bValue ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushString() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a string on to the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushString( char * szText, ULONG length ) --> void + * $ARGUMENTS$ + * + * + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushDate() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a long date onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushDate( long lDate ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushSymbol() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pushes a function pointer onto the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushSymbol( PHB_SYMB pSym ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_vmPushPointer() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Push an item of HB_IT_POINTER type + * $SYNTAX$ + * C Prototype + * + * #include + * hb_vmPushPointer( void * ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stackDispCall() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stackDispCall( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * hb_stackPop() + * $CATEGORY$ + * Virtual machine API + * $ONELINER$ + * Pops an item from the stack + * $SYNTAX$ + * C Prototype + * + * #include + * hb_stackPop( void ) --> void + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $EXAMPLES$ + * + * $STATUS$ + * R + * $COMPLIANCE$ + * Compliance is not applicable to API calls. + * $FILES$ + * Library is vm + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ +