Harbour Reference Guide - C level API
C level API
Date/Time
hb_dateCDOW()
Syntax
C Prototype
#include <hbdate.h> hb_dateCDOW( int iDay ) --> ( char * )pszResult
Argument(s)
<iDay>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateCMonth()
Syntax
C Prototype
#include <hbdate.h> hb_dateCMonth( int iMonth ) --> ( char *
)pszResult
Argument(s)
<iMonth>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateDOW()
Syntax
C Prototype
#include <hbdate.h> hb_dateDOW( long lYear, long lMonth, long lDay )
--> ( long )lResult
Argument(s)
<lYear>
<lMonth>
<lDay>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateDecStr()
Syntax
C Prototype
#include <hbdate.h> hb_dateDecStr( char * szDate, long lJulian ) -->
( char * )pszResult
Argument(s)
<szDate>
<lJulian>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateDecode()
Syntax
C Prototype
#include <hbdate.h> hb_dateDecode( long julian, long * plYear, long *
plMonth, long * plDay )
Argument(s)
<julian>
<plYear>
<plMonth>
<plDay>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateEncStr()
Syntax
C Prototype
#include <hbdate.h> hb_dateEncStr( char * szDate ) --> ( long )lResult
Argument(s)
<szDate>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateEncode()
Syntax
C Prototype
#include <hbdate.h> hb_dateEncode( long lYear, long lMonth, long lDay
) --> ( long )lResult
Argument(s)
<lYear>
<lMonth>
<lDay>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateFormat()
Syntax
C Prototype
#include <hbdate.h> hb_dateFormat( const char * szDate, char *
szFormattedDate, const char * szDateFormat ) --> ( char * )pszResult
Argument(s)
<szDate>
<szFormattedDate>
<szDateFormat>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateSeconds()
Syntax
C Prototype
#include <hbdate.h> hb_dateSeconds( void ) --> ( double )dResult
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateStrGet()
Syntax
C Prototype
#include <hbdate.h> hb_dateStrGet( const char * szDate, long * plYear,
long * plMonth, long * plDay )
Argument(s)
<szDate>
<plYear>
<plMonth>
<plDay>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateStrPut()
Syntax
C Prototype
#include <hbdate.h> hb_dateStrPut( char * szDate, long lYear, long
lMonth, long lDay )
Argument(s)
<szDate>
<lYear>
<lMonth>
<lDay>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateTimeStr()
Get the current workstation time
Syntax
C Prototype
#include <hbdate.h> hb_dateTimeStr( char * pszTime )
Argument(s)
<pszTime>
Description
The current workstation time is stored into the buffer pointed to by
pszTime. This buffer must be at least nine characters long.
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_dateToday()
Syntax
C Prototype
#include <hbdate.h> hb_dateToday( long * plYear, long * plMonth, long
* plDay )
Argument(s)
<plYear>
<plMonth>
<plDay>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
Environment
hb_setInitialize()
Syntax
C Prototype
#include <hbset.h> hb_setInitialize( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_setListenerAdd()
Syntax
C Prototype
#include <hbset.h> hb_setListenerAdd( PHB_SET_LISTENER_CALLBACK
callback ) --> int
Argument(s)
<callback> A pointer to a function taking two enum parameters and
returning no value. The first parameter identifies the SET parameter
that is to be changed and the second parameter identifies whether the
call is from before or after the value is changed. The callback
function will be called twice whenever a SET parameter is changed
using the Harbour SET function. The first call takes place before the
SET value is changed and the second one is after the SET parameter
has been changed.
Returns
An integer value representing the callback handle, in case the caller
needs to deactivate the callback function.
Description
This function allows a subsystem that needs to track the status of
some SET parameters to be notified whenever a SET parameter gets
changed.
Example(s)
void callback_function( HB_set_enum set, HB_set_listener_enum when )
{
printf("\nCalled for SET parameter %d %s changing.",
set, (when ? "after" : "before"));
}
int handle = hb_setListenerAdd( callback_function );
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
See also
hb_setListenerRemove()
Index
C level API
hb_setListenerNotify()
Syntax
C Prototype
#include <hbset.h> hb_setListenerNotify( HB_set_enum set,
HB_set_listener_enum when ) --> int
Argument(s)
<set> The number of the SET parameter that is to be or was changed.
<when> Set to HB_SET_LISTENER_BEFORE when called before the SET
parameter is to be changed and set to HB_SET_LISTENER_AFTER when
called after the SET parameter has been changed.
Returns
<int>
Description
This function notifies all SET listener callback functions. It must
be called any time you change the value of a SET parameter directly
instead of using the Harbour SET function. Both before and after the
change.
Example(s)
hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_BEFORE );
hb_set.HB_SET_DECIMALS = 3;
hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_AFTER );
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
See also
hb_setListenerAdd()
Index
C level API
hb_setListenerRemove()
Syntax
C Prototype
#include <hbset.h> hb_setListenerRemove( int handle ) --> int
Argument(s)
<handle> The handle for the SET listener callback function to be
removed.
Returns
The handle if the callback function could not be located or the
negative value of the handle if the callback function was removed.
Description
This function removes a SET listener callback function.
Example(s)
int handle = hb_setListenerAdd( callback_function );
...
hb_setListenerRemove( handle );
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
See also
hb_setListenerAdd()
Index
C level API
hb_setRelease()
Syntax
C Prototype
#include <hbset.h> hb_setRelease( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
Error
hb_errExit()
Syntax
C Prototype
#include <hbapierr.h> hb_errExit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetDescription()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetDescription( PHB_ITEM pError ) --> (
char * )pszResult
Argument(s)
<pError>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetFileName()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetFileName( PHB_ITEM pError ) --> ( char
* )pszResult
Argument(s)
<pError>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetFlags()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetFlags( PHB_ITEM pError ) --> ( USHORT
)usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetGenCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetGenCode( PHB_ITEM pError ) --> (
USHORT )usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetOperation()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetOperation( PHB_ITEM pError ) --> (
char * )pszResult
Argument(s)
<pError>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetOsCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetOsCode( PHB_ITEM pError ) --> ( USHORT
)usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetSeverity()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetSeverity( PHB_ITEM pError ) --> (
USHORT )usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetSubCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetSubCode( PHB_ITEM pError ) --> (
USHORT )usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetSubSystem()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetSubSystem( PHB_ITEM pError ) --> (
char * )pszResult
Argument(s)
<pError>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errGetTries()
Syntax
C Prototype
#include <hbapierr.h> hb_errGetTries( PHB_ITEM pError ) --> ( USHORT
)usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errInit()
Syntax
C Prototype
#include <hbapierr.h> hb_errInit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errInternal()
Syntax
C Prototype
#include <hbapierr.h> hb_errInternal( ULONG ulIntCode, char * szText,
char * szPar1, char * szPar2 )
Argument(s)
<ulIntCode>
<szText>
<szPar1>
<szPar2>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errLaunch()
Syntax
C Prototype
#include <hbapierr.h> hb_errLaunch( PHB_ITEM pError ) --> ( USHORT
)usResult
Argument(s)
<pError>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errLaunchSubst()
Syntax
C Prototype
#include <hbapierr.h> hb_errLaunchSubst( PHB_ITEM pError ) --> (
PHB_ITEM )pResult
Argument(s)
<pError>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errNew()
Syntax
C Prototype
#include <hbapierr.h> hb_errNew( void ) --> ( PHB_ITEM )pResult
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutArgs()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutArgs( PHB_ITEM pError, USHORT
uiArgCount, ... ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiArgCount>
<...>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutDescription()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutDescription( PHB_ITEM pError, char *
szDescription ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<szDescription>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutFileName()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutFileName( PHB_ITEM pError, char *
szFileName ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<szFileName>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutFlags()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutFlags( PHB_ITEM pError, USHORT uiFlags
) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiFlags>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutGenCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutGenCode( PHB_ITEM pError, USHORT
uiGenCode ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiGenCode>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutOperation()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutOperation( PHB_ITEM pError, char *
szOperation ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<szOperation>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutOsCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutOsCode( PHB_ITEM pError, USHORT
uiOsCode ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiOsCode>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutSeverity()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutSeverity( PHB_ITEM pError, USHORT
uiSeverity ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiSeverity>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutSubCode()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutSubCode( PHB_ITEM pError, USHORT
uiSubCode ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiSubCode>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutSubSystem()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutSubSystem( PHB_ITEM pError, char *
szSubSystem ) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<szSubSystem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errPutTries()
Syntax
C Prototype
#include <hbapierr.h> hb_errPutTries( PHB_ITEM pError, USHORT uiTries
) --> ( PHB_ITEM )pResult
Argument(s)
<pError>
<uiTries>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_BASE()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_BASE( ULONG ulGenCode, ULONG ulSubCode,
char * szDescription, char * szOperation ) --> ( USHORT )usResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_BASE_Ext1()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_BASE_Ext1( ULONG ulGenCode, ULONG
ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode,
USHORT uiFlags ) --> ( USHORT )usResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
<uiOsCode>
<uiFlags>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_BASE_Subst()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_BASE_Subst( ULONG ulGenCode, ULONG
ulSubCode, char * szDescription, char * szOperation ) --> ( PHB_ITEM
)pResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_BASE_SubstR()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_BASE_SubstR( ULONG ulGenCode, ULONG
ulSubCode, char * szDescription, char * szOperation )
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_DBCMD()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_DBCMD( ULONG ulGenCode, ULONG
ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT
)usResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_New()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_New( USHORT uiSeverity, char *
szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription,
char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM
)pResult
Argument(s)
<uiSeverity>
<szSubSystem>
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
<uiOsCode>
<uiFlags>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_New_Subst()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_New_Subst( USHORT uiSeverity, char *
szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription,
char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM
)pResult
Argument(s)
<uiSeverity>
<szSubSystem>
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
<uiOsCode>
<uiFlags>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_TERM()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_TERM( ULONG ulGenCode, ULONG ulSubCode,
char * szDescription, char * szOperation, USHORT uiOSCode, USHORT
uiFlags ) --> ( USHORT )usResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
<uiOSCode>
<uiFlags>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRT_TOOLS()
Syntax
C Prototype
#include <hbapierr.h> hb_errRT_TOOLS( ULONG ulGenCode, ULONG
ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT
)usResult
Argument(s)
<ulGenCode>
<ulSubCode>
<szDescription>
<szOperation>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errRelease()
Syntax
C Prototype
#include <hbapierr.h> hb_errRelease( PHB_ITEM pError )
Argument(s)
<pError>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_errorHandler()
Syntax
C Prototype
#include <hbapierr.h> hb_errorHandler( HB_ERROR_INFO_PTR pNewHandler
) --> ( HB_ERROR_INFO_PTR )hParam
Argument(s)
<pNewHandler>
Returns
<hParam>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
Extend
HB_ISSPACE()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_ISSPACE( c ) --> <see ( ( c ) == ' ' || ( c )
== HB_CHAR_HT || ( c ) == HB_CHAR_LF || ( c ) == HB_CHAR_CR )>
Argument(s)
<c>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_ARRAY()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_ARRAY( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_ARRAY )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_BLOCK()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_BLOCK( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_BLOCK )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_BYREF()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_BYREF( p ) --> <see ( ( p )->type &
HB_IT_BYREF )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_DATE()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_DATE( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_DATE )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_DOUBLE()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_DOUBLE( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_DOUBLE )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_INTEGER()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_INTEGER( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_INTEGER )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_LOGICAL()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_LOGICAL( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_LOGICAL )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_LONG()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_LONG( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_LONG )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_MEMO()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_MEMO( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_MEMO )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_MEMVAR()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_MEMVAR( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_MEMVAR )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_NIL()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_NIL( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_NIL )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_NUMERIC()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_NUMERIC( p ) --> <see ( ( p )->type &
HB_IT_NUMERIC )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_OBJECT()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_OBJECT( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_OBJECT )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_OF_TYPE()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_OF_TYPE( p, t ) --> <see ( ( ( p )->type &
~HB_IT_BYREF ) == t )>
Argument(s)
<p>
<t>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_POINTER()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_POINTER( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_POINTER )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_STRING()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_STRING( p ) --> <see ( ( ( p )->type & ~(
HB_IT_BYREF | HB_IT_MEMOFLAG ) ) == HB_IT_STRING )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
HB_IS_SYMBOL()
Syntax
C Prototype (macro definition)
#include <hbapi.h> HB_IS_SYMBOL( p ) --> <see HB_IS_OF_TYPE( p,
HB_IT_SYMBOL )>
Argument(s)
<p>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISARRAY()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISARRAY( n ) --> <see ( hb_param( n, HB_IT_ARRAY )
!= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISBLOCK()
Not available in CA-Cl*pper.
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISBLOCK( n ) --> <see ( hb_param( n, HB_IT_BLOCK )
!= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISBYREF()
NOTE: Intentionally using a different method
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISBYREF( n ) --> <see ( hb_parinfo( n ) &
HB_IT_BYREF )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISCHAR()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISCHAR( n ) --> <see ( hb_param( n, HB_IT_STRING )
!= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISDATE()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISDATE( n ) --> <see ( hb_param( n, HB_IT_DATE ) !
= NULL )>
Argument(s)
<n>
Returns
<see ( hb_param( n, HB_IT_DATE ) != NULL )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISLOG()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISLOG( n ) --> <see ( hb_param( n, HB_IT_LOGICAL )
!= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISMEMO()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISMEMO( n ) --> <see ( hb_param( n, HB_IT_MEMO ) !
= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISNIL()
NOTE: Intentionally using a different method
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISNIL( n ) --> <see ( hb_param( n, HB_IT_ANY ) ==
NULL || HB_IS_NIL( hb_param( n, HB_IT_ANY ) ) )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISNUM()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISNUM( n ) --> <see ( hb_param( n, HB_IT_NUMERIC )
!= NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISOBJECT()
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISOBJECT( n ) --> <see ( ISARRAY( n ) && hb_param(
n, HB_IT_ARRAY )->asArray.value->uiClass != 0 )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
ISPOINTER()
Not available in CA-Cl*pper.
Syntax
C Prototype (macro definition)
#include <hbapi.h> ISPOINTER( n ) --> <see ( hb_param( n,
HB_IT_POINTER ) != NULL )>
Argument(s)
<n>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapi.h
Index
C level API
hb_arrayAdd()
Add a new item to the end of an array item
Syntax
C Prototype
#include <hbapi.h> hb_arrayAdd( PHB_ITEM pArray, PHB_ITEM pItemValue
) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<pItemValue>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayClone()
Returns a duplicate of an existing array, including all nested items
Syntax
C Prototype
#include <hbapi.h> hb_arrayClone( PHB_ITEM pArray ) --> ( PHB_ITEM
)pResult
Argument(s)
<pArray>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayCopy()
Copy items from one array to another
Syntax
C Prototype
#include <hbapi.h> hb_arrayCopy( PHB_ITEM pSrcArray, PHB_ITEM
pDstArray, ULONG * pulStart, ULONG * pulCount, ULONG * pulTarget )
--> ( HB_BOOL )bResult
Argument(s)
<pSrcArray>
<pDstArray>
<pulStart>
<pulCount>
<pulTarget>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayCopyC()
Copy a string into an array item
Syntax
C Prototype
#include <hbapi.h> hb_arrayCopyC( PHB_ITEM pArray, ULONG ulIndex,
char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult
Argument(s)
<pArray>
<ulIndex>
<szBuffer>
<ulLen>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayDel()
Delete an array item, without changing length
Syntax
C Prototype
#include <hbapi.h> hb_arrayDel( PHB_ITEM pArray, ULONG ulIndex ) -->
( HB_BOOL )bResult
Argument(s)
<pArray>
<ulIndex>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayEval()
Execute a code-block for every element of an array item
Syntax
C Prototype
#include <hbapi.h> hb_arrayEval( PHB_ITEM pArray, PHB_ITEM bBlock,
ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<bBlock>
<pulStart>
<pulCount>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayFill()
Fill an array with a given item
Syntax
C Prototype
#include <hbapi.h> hb_arrayFill( PHB_ITEM pArray, PHB_ITEM pValue,
ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<pValue>
<pulStart>
<pulCount>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGet()
Retrieves an item
Syntax
C Prototype
#include <hbapi.h> hb_arrayGet( PHB_ITEM pArray, ULONG ulIndex,
PHB_ITEM pItem ) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<ulIndex>
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetC()
Retrieves the string contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetC( PHB_ITEM pArray, ULONG ulIndex ) -->
( char * )pszResult
Argument(s)
<pArray>
<ulIndex>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetCLen()
Retrieves the string length contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetCLen( PHB_ITEM pArray, ULONG ulIndex )
--> ( ULONG )ulResult
Argument(s)
<pArray>
<ulIndex>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetCPtr()
Retrieves the string pointer on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetCPtr( PHB_ITEM pArray, ULONG ulIndex )
--> ( char * )pszResult
Argument(s)
<pArray>
<ulIndex>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetDL()
Retrieves the date value contained in an array element, as a long
integer
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetDL( PHB_ITEM pArray, ULONG ulIndex )
--> ( long )lResult
Argument(s)
<pArray>
<ulIndex>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetDS()
Retrieves the date value contained in an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetDS( PHB_ITEM pArray, ULONG ulIndex,
char * szDate ) --> ( char * )pszResult
Argument(s)
<pArray>
<ulIndex>
<szDate>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetItemPtr()
Returns pointer to specified element of the array
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetItemPtr( PHB_ITEM pArray, ULONG ulIndex
) --> ( PHB_ITEM )pResult
Argument(s)
<pArray>
<ulIndex>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetL()
Retrieves the logical value contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetL( PHB_ITEM pArray, ULONG ulIndex ) -->
( HB_BOOL )bResult
Argument(s)
<pArray>
<ulIndex>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetND()
Retrieves the double value contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetND( PHB_ITEM pArray, ULONG ulIndex )
--> ( double )dResult
Argument(s)
<pArray>
<ulIndex>
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetNI()
Retrieves the int value contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetNI( PHB_ITEM pArray, ULONG ulIndex )
--> ( int )iResult
Argument(s)
<pArray>
<ulIndex>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetNL()
Retrieves the long numeric value contained on an array element
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetNL( PHB_ITEM pArray, ULONG ulIndex )
--> ( long )lResult
Argument(s)
<pArray>
<ulIndex>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayGetType()
Retrieves the type of an array item
Syntax
C Prototype
#include <hbapi.h> hb_arrayGetType( PHB_ITEM pArray, ULONG ulIndex )
--> ( USHORT )usResult
Argument(s)
<pArray>
<ulIndex>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayIns()
Insert a nil item into an array, without changing the length
Syntax
C Prototype
#include <hbapi.h> hb_arrayIns( PHB_ITEM pArray, ULONG ulIndex ) -->
( HB_BOOL )bResult
Argument(s)
<pArray>
<ulIndex>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayIsObject()
Retrives if the array is an object
Syntax
C Prototype
#include <hbapi.h> hb_arrayIsObject( PHB_ITEM pArray ) --> ( HB_BOOL
)bResult
Argument(s)
<pArray>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayLast()
Retrieve last item in an array
Syntax
C Prototype
#include <hbapi.h> hb_arrayLast( PHB_ITEM pArray, PHB_ITEM pResult )
--> ( HB_BOOL )bResult
Argument(s)
<pArray>
<pResult>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayLen()
Retrives the array len
Syntax
C Prototype
#include <hbapi.h> hb_arrayLen( PHB_ITEM pArray ) --> ( ULONG
)ulResult
Argument(s)
<pArray>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayNew()
Creates a new array
Syntax
C Prototype
#include <hbapi.h> hb_arrayNew( PHB_ITEM pItem, ULONG ulLen ) --> (
HB_BOOL )bResult
Argument(s)
<pItem>
<ulLen>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayRelease()
Releases an array - don't call it - use ItemRelease() !!!
Syntax
C Prototype
#include <hbapi.h> hb_arrayRelease( PHB_ITEM pArray ) --> ( HB_BOOL
)bResult
Argument(s)
<pArray>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayReleaseGarbage()
Clear an array before releasing by the GC
Syntax
C Prototype
#include <hbapi.h> hb_arrayReleaseGarbage( void * Cargo )
Argument(s)
<Cargo>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arrayScan()
Scan an array for a given item, or until code-block item returns TRUE
Syntax
C Prototype
#include <hbapi.h> hb_arrayScan( PHB_ITEM pArray, PHB_ITEM pValue,
ULONG * pulStart, ULONG * pulCount ) --> ( ULONG )ulResult
Argument(s)
<pArray>
<pValue>
<pulStart>
<pulCount>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arraySet()
Sets an array element
Syntax
C Prototype
#include <hbapi.h> hb_arraySet( PHB_ITEM pArray, ULONG ulIndex,
PHB_ITEM pItem ) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<ulIndex>
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arraySize()
Sets the array total length
Syntax
C Prototype
#include <hbapi.h> hb_arraySize( PHB_ITEM pArray, ULONG ulLen ) --> (
HB_BOOL )bResult
Argument(s)
<pArray>
<ulLen>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_arraySort()
Sorts an array item
Syntax
C Prototype
#include <hbapi.h> hb_arraySort( PHB_ITEM pArray, ULONG * pulStart,
ULONG * pulCount, PHB_ITEM pBlock ) --> ( HB_BOOL )bResult
Argument(s)
<pArray>
<pulStart>
<pulCount>
<pBlock>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_clsIsClassRef()
Classes.c - mark all class internals as used
Syntax
C Prototype
#include <hbapi.h> hb_clsIsClassRef( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_clsReleaseAll()
Releases all defined classes
Syntax
C Prototype
#include <hbapi.h> hb_clsReleaseAll( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargARGC()
Retrieve command line argument count
Syntax
C Prototype
#include <hbapi.h> hb_cmdargARGC( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargARGV()
Retrieve command line argument buffer pointer
Syntax
C Prototype
#include <hbapi.h> hb_cmdargARGV( void ) --> ( char ** )ppszResult
Returns
<ppszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargCheck()
Check if a given internal switch (like //INFO) was set
Syntax
C Prototype
#include <hbapi.h> hb_cmdargCheck( const char * pszName ) --> (
HB_BOOL )bResult
Argument(s)
<pszName>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargInit()
Initialize command line argument API's
Syntax
C Prototype
#include <hbapi.h> hb_cmdargInit( int argc, char * argv[] )
Argument(s)
<argc>
<argv[]>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargIsInternal()
Determine if a string is an internal setting
Syntax
C Prototype
#include <hbapi.h> hb_cmdargIsInternal( const char * szArg ) --> (
HB_BOOL )bResult
Argument(s)
<szArg>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargNum()
Returns the numeric value of an internal switch (like //F:90)
Syntax
C Prototype
#include <hbapi.h> hb_cmdargNum( const char * pszName ) --> ( int
)iResult
Argument(s)
<pszName>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargProcessVM()
Check for command line internal arguments
Syntax
C Prototype
#include <hbapi.h> hb_cmdargProcessVM( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_cmdargString()
Returns the string value of an internal switch (like //TEMPPATH:"C:\")
Syntax
C Prototype
#include <hbapi.h> hb_cmdargString( const char * pszName ) --> ( char
* )pszResult
Argument(s)
<pszName>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockCopy()
Copy a codeblock
Syntax
C Prototype
#include <hbapi.h> hb_codeblockCopy( PHB_ITEM pDest, PHB_ITEM pSource
)
Argument(s)
<pDest>
<pSource>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockDelete()
Delete a codeblock
Syntax
C Prototype
#include <hbapi.h> hb_codeblockDelete( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockDeleteGarbage()
Clear a codeblock before releasing by the GC
Syntax
C Prototype
#include <hbapi.h> hb_codeblockDeleteGarbage( void * Cargo )
Argument(s)
<Cargo>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockEvaluate()
Evaluate a codeblock
Syntax
C Prototype
#include <hbapi.h> hb_codeblockEvaluate( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockGetRef()
Get local variable passed by reference
Syntax
C Prototype
#include <hbapi.h> hb_codeblockGetRef( PHB_ITEM pItem, PHB_ITEM
pRefer ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<pRefer>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockGetVar()
Get local variable referenced in a codeblock
Syntax
C Prototype
#include <hbapi.h> hb_codeblockGetVar( PHB_ITEM pItem, LONG iItemPos
) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<iItemPos>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockMacroNew()
Syntax
C Prototype
#include <hbapi.h> hb_codeblockMacroNew( BYTE * pBuffer, USHORT usLen
) --> ( HB_CODEBLOCK_PTR )hResult
Argument(s)
<pBuffer>
<usLen>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_codeblockNew()
Create a code-block
Syntax
C Prototype
#include <hbapi.h> hb_codeblockNew( BYTE * pBuffer, USHORT uiLocals,
USHORT * pLocalPosTable, PHB_SYMB pSymbols ) --> ( HB_CODEBLOCK_PTR
)hResult
Argument(s)
<pBuffer>
<uiLocals>
<pLocalPosTable>
<pSymbols>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_compReservedName()
Determines if a string contains a reserve word
Syntax
C Prototype
#include <hbapi.h> hb_compReservedName( char * szName ) --> ( char *
)pszResult
Argument(s)
<szName>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conInit()
Initialize the console API system
Syntax
C Prototype
#include <hbapi.h> hb_conInit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conNewLine()
Retrieve a pointer to a static buffer containing new-line characters
Syntax
C Prototype
#include <hbapi.h> hb_conNewLine( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conOutErr()
Output an string to STDERR
Syntax
C Prototype
#include <hbapi.h> hb_conOutErr( char * pStr, ULONG ulLen )
Argument(s)
<pStr>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conOutStd()
Output an string to STDOUT
Syntax
C Prototype
#include <hbapi.h> hb_conOutStd( char * pStr, ULONG ulLen )
Argument(s)
<pStr>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conRelease()
Release the console API system
Syntax
C Prototype
#include <hbapi.h> hb_conRelease( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conSetColor()
Retrieve and optionally set console color
Syntax
C Prototype
#include <hbapi.h> hb_conSetColor( char * szColor ) --> ( char *
)pszResult
Argument(s)
<szColor>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conSetCursor()
Retrieve and optionally set cursor shape
Syntax
C Prototype
#include <hbapi.h> hb_conSetCursor( HB_BOOL bSetCursor, USHORT
usNewCursor ) --> ( USHORT )usResult
Argument(s)
<bSetCursor>
<usNewCursor>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_conXSaveRestRelease()
Release the save/restore API
Syntax
C Prototype
#include <hbapi.h> hb_conXSaveRestRelease( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymEval()
Enumerates all dynamic symbols
Syntax
C Prototype
#include <hbapi.h> hb_dynsymEval( PHB_DYNS_FUNC pFunction, void *
Cargo )
Argument(s)
<pFunction>
<Cargo>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymFind()
Finds a dynamic symbol
Syntax
C Prototype
#include <hbapi.h> hb_dynsymFind( char * szName ) --> ( PHB_DYNS
)hResult
Argument(s)
<szName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymFindName()
Converts to uppercase and finds a dynamic symbol
Syntax
C Prototype
#include <hbapi.h> hb_dynsymFindName( char * szName ) --> ( PHB_DYNS
)hResult
Argument(s)
<szName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymGet()
Finds and creates a dynamic symbol if not found
Syntax
C Prototype
#include <hbapi.h> hb_dynsymGet( char * szName ) --> ( PHB_DYNS
)hResult
Argument(s)
<szName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymLog()
Displays all dynamic symbols
Syntax
C Prototype
#include <hbapi.h> hb_dynsymLog( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymNew()
Creates a new dynamic symbol based on a local one
Syntax
C Prototype
#include <hbapi.h> hb_dynsymNew( PHB_SYMB pSymbol ) --> ( PHB_DYNS
)hResult
Argument(s)
<pSymbol>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_dynsymRelease()
Releases the memory of the dynamic symbol table
Syntax
C Prototype
#include <hbapi.h> hb_dynsymRelease( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcAlloc()
Allocates a memory controlled by the garbage collector
Syntax
C Prototype
#include <hbapi.h> hb_gcAlloc( ULONG ulSize, HB_GARBAGE_FUNC_PTR
pFunc ) --> ( void * )pResult
Argument(s)
<ulSize>
<pFunc>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcCollect()
Checks if a single memory block can be released
Syntax
C Prototype
#include <hbapi.h> hb_gcCollect( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcCollectAll()
Checks if all memory blocks can be released
Syntax
C Prototype
#include <hbapi.h> hb_gcCollectAll( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcFree()
Deallocates a memory allocated by the garbage collector
Syntax
C Prototype
#include <hbapi.h> hb_gcFree( void *pAlloc )
Argument(s)
<*pAlloc>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcItemRef()
Checks if passed item refers passed memory block pointer
Syntax
C Prototype
#include <hbapi.h> hb_gcItemRef( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcLock()
Do not release passed memory block
Syntax
C Prototype
#include <hbapi.h> hb_gcLock( void *pAlloc ) --> ( void * )pResult
Argument(s)
<*pAlloc>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcLockItem()
Do not release a memory block stored inside an item
Syntax
C Prototype
#include <hbapi.h> hb_gcLockItem( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcUnlock()
Passed block is allowed to be released
Syntax
C Prototype
#include <hbapi.h> hb_gcUnlock( void *pAlloc ) --> ( void * )pResult
Argument(s)
<*pAlloc>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_gcUnlockItem()
Allow to release the item
Syntax
C Prototype
#include <hbapi.h> hb_gcUnlockItem( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_idleReset()
Services a single idle state
Syntax
C Prototype
#include <hbapi.h> hb_idleReset( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_idleShutDown()
Closes all background tasks
Syntax
C Prototype
#include <hbapi.h> hb_idleShutDown( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_idleState()
Services a single idle state
Syntax
C Prototype
#include <hbapi.h> hb_idleState( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroCompile()
Compile a string and return a pcode buffer
Syntax
C Prototype
#include <hbapi.h> hb_macroCompile( char * szString ) --> (
HB_MACRO_PTR )hResult
Argument(s)
<szString>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroDelete()
Release all memory allocated for macro evaluation
Syntax
C Prototype
#include <hbapi.h> hb_macroDelete( HB_MACRO_PTR pMacro )
Argument(s)
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroGetType()
Determine the type of an expression
Syntax
C Prototype
#include <hbapi.h> hb_macroGetType( HB_ITEM_PTR pItem ) --> ( char *
)pszResult
Argument(s)
<pItem>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroGetValue()
Retrieve results of a macro expansion
Syntax
C Prototype
#include <hbapi.h> hb_macroGetValue( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroIsIdent()
Determine if a string is a valid function or variable name
Syntax
C Prototype
#include <hbapi.h> hb_macroIsIdent( char * szString ) --> ( HB_BOOL
)bResult
Argument(s)
<szString>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroPopAliasedValue()
Compiles and evaluates an aliased macro expression
Syntax
C Prototype
#include <hbapi.h> hb_macroPopAliasedValue( HB_ITEM_PTR pAlias,
HB_ITEM_PTR pVar )
Argument(s)
<pAlias>
<pVar>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroPushAliasedValue()
Compiles and evaluates an aliased macro expression
Syntax
C Prototype
#include <hbapi.h> hb_macroPushAliasedValue( HB_ITEM_PTR pAlias,
HB_ITEM_PTR pVar )
Argument(s)
<pAlias>
<pVar>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroPushSymbol()
Handle a macro function calls, e.g. var := ¯o()
Syntax
C Prototype
#include <hbapi.h> hb_macroPushSymbol( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroRun()
Executes pcode compiled by macro compiler
Syntax
C Prototype
#include <hbapi.h> hb_macroRun( HB_MACRO_PTR pMacro )
Argument(s)
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroSetValue()
Assign a value to a macro-expression item
Syntax
C Prototype
#include <hbapi.h> hb_macroSetValue( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroTextSubst()
Substitute macro variables occurences within a given string
Syntax
C Prototype
#include <hbapi.h> hb_macroTextSubst( char * szString, ULONG
*pulStringLen ) --> ( char * )pszResult
Argument(s)
<szString>
<*pulStringLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_macroTextValue()
Macro text substitution
Syntax
C Prototype
#include <hbapi.h> hb_macroTextValue( HB_ITEM_PTR pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarCreateFromItem()
Syntax
C Prototype
#include <hbapi.h> hb_memvarCreateFromItem( PHB_ITEM pMemvar, BYTE
bScope, PHB_ITEM pValue )
Argument(s)
<pMemvar>
<bScope>
<pValue>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarGet()
Copy an symbol value into an item
Syntax
C Prototype
#include <hbapi.h> hb_memvarGet( HB_ITEM_PTR pItem, PHB_SYMB
pMemvarSymb ) --> ( HB_ERRCODE )hResult
Argument(s)
<pItem>
<pMemvarSymb>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarGetPrivatesBase()
Retrieve current PRIVATE variables stack base
Syntax
C Prototype
#include <hbapi.h> hb_memvarGetPrivatesBase( void ) --> ( ULONG
)ulResult
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarGetRefer()
Copy a reference to a symbol value into an item, with error trapping
Syntax
C Prototype
#include <hbapi.h> hb_memvarGetRefer( HB_ITEM_PTR pItem, PHB_SYMB
pMemvarSymb )
Argument(s)
<pItem>
<pMemvarSymb>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarGetStrValuePtr()
Syntax
C Prototype
#include <hbapi.h> hb_memvarGetStrValuePtr( char * szVarName, ULONG
*pulLen ) --> ( char * )pszResult
Argument(s)
<szVarName>
<*pulLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarGetValue()
Copy an symbol value into an item, with error trapping
Syntax
C Prototype
#include <hbapi.h> hb_memvarGetValue( HB_ITEM_PTR pItem, PHB_SYMB
pMemvarSymb )
Argument(s)
<pItem>
<pMemvarSymb>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarNewParameter()
Syntax
C Prototype
#include <hbapi.h> hb_memvarNewParameter( PHB_SYMB pSymbol, PHB_ITEM
pValue )
Argument(s)
<pSymbol>
<pValue>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarScope()
Retrieve scope of a dynamic variable symbol
Syntax
C Prototype
#include <hbapi.h> hb_memvarScope( char * szVarName, ULONG ulLength )
--> ( int )iResult
Argument(s)
<szVarName>
<ulLength>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarSetPrivatesBase()
Release PRIVATE variables created after specified base
Syntax
C Prototype
#include <hbapi.h> hb_memvarSetPrivatesBase( ULONG ulBase )
Argument(s)
<ulBase>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarSetValue()
Copy an item into a symbol
Syntax
C Prototype
#include <hbapi.h> hb_memvarSetValue( PHB_SYMB pMemvarSymb,
HB_ITEM_PTR pItem )
Argument(s)
<pMemvarSymb>
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarValueBaseAddress()
Retrieve the base address of the values table
Syntax
C Prototype
#include <hbapi.h> hb_memvarValueBaseAddress( void ) --> (
HB_VALUE_PTR * )phResult
Returns
<phResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarValueDecRef()
Decrease the reference count of a global value
Syntax
C Prototype
#include <hbapi.h> hb_memvarValueDecRef( HB_HANDLE hValue )
Argument(s)
<hValue>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarValueIncRef()
Increase the reference count of a global value
Syntax
C Prototype
#include <hbapi.h> hb_memvarValueIncRef( HB_HANDLE hValue )
Argument(s)
<hValue>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarValueNew()
Create a new global value
Syntax
C Prototype
#include <hbapi.h> hb_memvarValueNew( HB_ITEM_PTR pSource, HB_BOOL
bTrueMemvar ) --> ( HB_HANDLE )hResult
Argument(s)
<pSource>
<bTrueMemvar>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarsFree()
Release the memvar API system
Syntax
C Prototype
#include <hbapi.h> hb_memvarsFree( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarsInit()
Initialize the memvar API system
Syntax
C Prototype
#include <hbapi.h> hb_memvarsInit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarsIsMemvarRef()
Memvars.c - mark all memvar variables as used
Syntax
C Prototype
#include <hbapi.h> hb_memvarsIsMemvarRef( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_memvarsRelease()
Clear all PUBLIC and PRIVATE variables
Syntax
C Prototype
#include <hbapi.h> hb_memvarsRelease( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_numRound()
Round a number to a specific number of digits
Syntax
C Prototype
#include <hbapi.h> hb_numRound( double dResult, int iDec ) --> (
double )dResult
Argument(s)
<dResult>
<iDec>
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_objGetClsName()
Retrieves an object class name
Syntax
C Prototype
#include <hbapi.h> hb_objGetClsName( PHB_ITEM pObject ) --> ( char *
)pszResult
Argument(s)
<pObject>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_objGetMethod()
Returns the method pointer of a object class
Syntax
C Prototype
#include <hbapi.h> hb_objGetMethod( PHB_ITEM pObject, PHB_SYMB
pSymMsg ) --> ( PHB_FUNC )hResult
Argument(s)
<pObject>
<pSymMsg>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_objHasMsg()
Returns TRUE/FALSE whether szString is an existing message for object
Syntax
C Prototype
#include <hbapi.h> hb_objHasMsg( PHB_ITEM pObject, char * szString )
--> ( ULONG )ulResult
Argument(s)
<pObject>
<szString>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_param()
Retrieve a direct pointer to an item parameter
Syntax
C Prototype
#include <hbapi.h> hb_param( int iParam, int iMask ) --> ( PHB_ITEM )
pResult
Argument(s)
<iParam> The 1-based parameter to retrieve.
<iMask>
Returns
hb_param() returns a direct pointer to an item on the eval stack.
Description
This item will be removed (set to NIL) after a function cleanup, so
if the item needs to survive the current function (e.g. copied to a
static) you should use hb_itemParam instead.
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
See also
hb_itemParam()
Index
C level API
hb_parc()
Retrieve a string parameter
Syntax
C Prototype
#include <hbapi.h> hb_parc( int iParam, ... ) --> ( char * )pszResult
Argument(s)
<iParam>
<...>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parclen()
Retrieve a string parameter length
Syntax
C Prototype
#include <hbapi.h> hb_parclen( int iParam, ... ) --> ( ULONG )ulResult
Argument(s)
<iParam>
<...>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parcsiz()
Retrieve a by-reference string parameter length, including terminator
Syntax
C Prototype
#include <hbapi.h> hb_parcsiz( int iParam, ... ) --> ( ULONG )ulResult
Argument(s)
<iParam>
<...>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_pards()
Retrieve a date as a string yyyymmdd
Syntax
C Prototype
#include <hbapi.h> hb_pards( int iParam, ... ) --> ( char * )pszResult
Argument(s)
<iParam>
<...>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_pardsbuff()
Retrieve a date as a string yyyymmdd
Syntax
C Prototype
#include <hbapi.h> hb_pardsbuff( char * szDate, int iParam, ... ) -->
( char * )pszResult
Argument(s)
<szDate>
<iParam>
<...>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parinfa()
Retrieve length or element type of an array parameter
Syntax
C Prototype
#include <hbapi.h> hb_parinfa( int iParamNum, ULONG uiArrayIndex )
--> ( ULONG )ulResult
Argument(s)
<iParamNum>
<uiArrayIndex>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parinfo()
Determine the param count or data type
Syntax
C Prototype
#include <hbapi.h> hb_parinfo( int iParam ) --> ( int )iResult
Argument(s)
<iParam>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parl()
Retrieve a logical parameter as an int
Syntax
C Prototype
#include <hbapi.h> hb_parl( int iParam, ... ) --> ( int )iResult
Argument(s)
<iParam>
<...>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parnd()
Retrieve a numeric parameter as a double
Syntax
C Prototype
#include <hbapi.h> hb_parnd( int iParam, ... ) --> ( double )dResult
Argument(s)
<iParam>
<...>
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parni()
Retrieve a numeric parameter as a integer
Syntax
C Prototype
#include <hbapi.h> hb_parni( int iParam, ... ) --> ( int )iResult
Argument(s)
<iParam>
<...>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_parnl()
Retrieve a numeric parameter as a long
Syntax
C Prototype
#include <hbapi.h> hb_parnl( int iParam, ... ) --> ( long )lResult
Argument(s)
<iParam>
<...>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_pcount()
Returns the number of supplied parameters
Syntax
C Prototype
#include <hbapi.h> hb_pcount( void ) --> ( int )iResult
Returns
<iResult>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_pcount() --> ( ( int ) hb_stack.pBase->item.asSymbol.
paramcnt )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_procname()
Retrieve a procedure name into a buffer
Syntax
C Prototype
#include <hbapi.h> hb_procname( int iLevel, char * szName ) --> (
char * )pszResult
Argument(s)
<iLevel>
<szName>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_ret()
Post a NIL return value
Syntax
C Prototype
#include <hbapi.h> hb_ret( void ) --> void
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_ret() --> hb_itemClear( &hb_stack.Return )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_reta()
Returns an array with a specific length
Syntax
C Prototype
#include <hbapi.h> hb_reta( ULONG ulLen )
Argument(s)
<ulLen>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_reta( ulLen ) --> hb_arrayNew( &hb_stack.Return,
ulLen )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retc()
Returns a string
Syntax
C Prototype
#include <hbapi.h> hb_retc( char * szText )
Argument(s)
<szText>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retc( szText ) --> hb_itemPutC( &hb_stack.Return,
szText )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retclen()
Returns a string with a specific length
Syntax
C Prototype
#include <hbapi.h> hb_retclen( char * szText, ULONG ulLen )
Argument(s)
<szText>
<ulLen>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retclen( szText, ulLen ) --> hb_itemPutCL( &hb_stack.
Return, szText, ulLen )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retd()
Returns a date
Syntax
C Prototype
#include <hbapi.h> hb_retd( long lYear, long lMonth, long lDay )
Argument(s)
<lYear>
<lMonth>
<lDay>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retd( lYear, lMonth, lDay ) --> hb_itemPutD(
&hb_stack.Return, lYear, lMonth, lDay )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retdl()
Returns a long value as a julian date
Syntax
C Prototype
#include <hbapi.h> hb_retdl( long lJulian )
Argument(s)
<lJulian>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retdl( lJulian ) --> hb_itemPutDL( &hb_stack.Return,
lJulian )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retds()
Returns a date, must use yyyymmdd format
Syntax
C Prototype
#include <hbapi.h> hb_retds( char * szDate )
Argument(s)
<szDate>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retds( szDate ) --> hb_itemPutDS( &hb_stack.Return,
szDate )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retl()
Returns a logical integer
Syntax
C Prototype
#include <hbapi.h> hb_retl( int iTrueFalse )
Argument(s)
<iTrueFalse>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retl( iLogical ) --> hb_itemPutL( &hb_stack.Return,
iLogical ? HB_TRUE : HB_FALSE )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retnd()
Returns a double
Syntax
C Prototype
#include <hbapi.h> hb_retnd( double dNumber )
Argument(s)
<dNumber>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retnd( dNumber ) --> hb_itemPutND( &hb_stack.Return,
dNumber )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retndlen()
Returns a double, with specific width and decimals
Syntax
C Prototype
#include <hbapi.h> hb_retndlen( double dNumber, int iWidth, int iDec )
Argument(s)
<dNumber>
<iWidth>
<iDec>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retndlen( dNumber, iWidth, iDec ) -->
hb_itemPutNDLen( &hb_stack.Return, dNumber, iWidth, iDec )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retni()
Returns a integer number
Syntax
C Prototype
#include <hbapi.h> hb_retni( int iNumber )
Argument(s)
<iNumber>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retni( iNumber ) --> hb_itemPutNI( &hb_stack.Return,
iNumber )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retnilen()
Returns a integer number, with specific width
Syntax
C Prototype
#include <hbapi.h> hb_retnilen( int iNumber, int iWidth )
Argument(s)
<iNumber>
<iWidth>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retnilen( iNumber, iWidth ) --> hb_itemPutNILen(
&hb_stack.Return, iNumber, iWidth )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retnl()
Returns a long number
Syntax
C Prototype
#include <hbapi.h> hb_retnl( long lNumber )
Argument(s)
<lNumber>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retnl( lNumber ) --> hb_itemPutNL( &hb_stack.Return,
lNumber )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retnlen()
Returns a double, with specific width and decimals
Syntax
C Prototype
#include <hbapi.h> hb_retnlen( double dNumber, int iWidth, int iDec )
Argument(s)
<dNumber>
<iWidth>
<iDec>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retnlen( dNumber, iWidth, iDec ) --> hb_itemPutNLen(
&hb_stack.Return, dNumber, iWidth, iDec )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_retnllen()
Returns a long number, with specific width
Syntax
C Prototype
#include <hbapi.h> hb_retnllen( long lNumber, int iWidth )
Argument(s)
<lNumber>
<iWidth>
Description
Note that when HB_API_MACROS is defined, this function is replaced
with a macro: hb_retnllen( lNumber, iWidth ) --> hb_itemPutNLLen(
&hb_stack.Return, lNumber, iWidth )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_storc()
Stores a szString on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_storc( char * szText, int iParam, ... )
Argument(s)
<szText>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_storclen()
Stores a fixed length string on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_storclen( char * szText, ULONG ulLength, int
iParam, ... )
Argument(s)
<szText>
<ulLength>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_stords()
SzDate must have yyyymmdd format
Syntax
C Prototype
#include <hbapi.h> hb_stords( char * szDate, int iParam, ... )
Argument(s)
<szDate>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_storl()
Stores a logical integer on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_storl( int iLogical, int iParam, ... )
Argument(s)
<iLogical>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_stornd()
Stores a double on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_stornd( double dValue, int iParam, ... )
Argument(s)
<dValue>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_storni()
Stores an integer on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_storni( int iValue, int iParam, ... )
Argument(s)
<iValue>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_stornl()
Stores a long on a variable by reference
Syntax
C Prototype
#include <hbapi.h> hb_stornl( long lValue, int iParam, ... )
Argument(s)
<lValue>
<iParam>
<...>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strAt()
Returns an index to a sub-string within another string
Syntax
C Prototype
#include <hbapi.h> hb_strAt( const char * szSub, ULONG ulSubLen,
const char * szText, ULONG ulLen ) --> ( ULONG )ulResult
Argument(s)
<szSub>
<ulSubLen>
<szText>
<ulLen>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strDescend()
Copy a string to a buffer, inverting each character
Syntax
C Prototype
#include <hbapi.h> hb_strDescend( char * szStringTo, const char *
szStringFrom, ULONG ulLen )
Argument(s)
<szStringTo>
<szStringFrom>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strEmpty()
Returns whether a string contains only white space
Syntax
C Prototype
#include <hbapi.h> hb_strEmpty( const char * szText, ULONG ulLen )
--> ( HB_BOOL )bResult
Argument(s)
<szText>
<ulLen>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strLTrim()
Return a pointer to the first non-white space character
Syntax
C Prototype
#include <hbapi.h> hb_strLTrim( const char * szText, ULONG * ulLen )
--> ( char * )pszResult
Argument(s)
<szText>
<ulLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strLower()
Convert an existing string buffer to lower case
Syntax
C Prototype
#include <hbapi.h> hb_strLower( char * szText, ULONG ulLen ) --> (
char * )pszResult
Argument(s)
<szText>
<ulLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strMatchRegExp()
Compare two strings using a regular expression pattern
Syntax
C Prototype
#include <hbapi.h> hb_strMatchRegExp( const char * szString, const
char * szMask ) --> ( HB_BOOL )bResult
Argument(s)
<szString>
<szMask>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strRTrimLen()
Return length of a string, ignoring trailing white space (or true
spaces)
Syntax
C Prototype
#include <hbapi.h> hb_strRTrimLen( const char * szText, ULONG ulLen,
HB_BOOL bAnySpace ) --> ( ULONG )ulResult
Argument(s)
<szText>
<ulLen>
<bAnySpace>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strUpper()
Convert an existing string buffer to upper case
Syntax
C Prototype
#include <hbapi.h> hb_strUpper( char * szText, ULONG ulLen ) --> (
char * )pszResult
Argument(s)
<szText>
<ulLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strVal()
Return the numeric value of a character string representation of a
number
Syntax
C Prototype
#include <hbapi.h> hb_strVal( const char * szText, ULONG ulLen ) -->
( double )dResult
Argument(s)
<szText>
<ulLen>
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strdup()
Returns a pointer to a newly allocated copy of the source string
Syntax
C Prototype
#include <hbapi.h> hb_strdup( const char * pszText ) --> ( char *
)pszResult
Argument(s)
<pszText>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_stricmp()
Compare two strings without regards to case
Syntax
C Prototype
#include <hbapi.h> hb_stricmp( const char * s1, const char * s2 ) -->
( int )iResult
Argument(s)
<s1>
<s2>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strncpyUpper()
Copy an existing string buffer to another buffer, as upper case
Syntax
C Prototype
#include <hbapi.h> hb_strncpyUpper( char * pDest, const char *
pSource, ULONG ulLen ) --> ( char * )pszResult
Argument(s)
<pDest>
<pSource>
<ulLen>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strnicmp()
Compare two string without regards to case, limited by length
Syntax
C Prototype
#include <hbapi.h> hb_strnicmp( const char * s1, const char * s2,
ULONG ulLen ) --> ( int )iResult
Argument(s)
<s1>
<s2>
<ulLen>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_strupr()
Convert a string in-place to upper-case
Syntax
C Prototype
#include <hbapi.h> hb_strupr( char * pszText ) --> ( char * )pszResult
Argument(s)
<pszText>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_symbolNew()
Create a new symbol
Syntax
C Prototype
#include <hbapi.h> hb_symbolNew( char * szName ) --> ( PHB_SYMB
)hResult
Argument(s)
<szName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_verBuildInfo()
Display harbour, compiler, and platform versions to standard console
Syntax
C Prototype
#include <hbapi.h> hb_verBuildInfo( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_verCompiler()
Retrieves a newly allocated buffer containing compiler version
Syntax
C Prototype
#include <hbapi.h> hb_verCompiler( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_verHarbour()
Retrieves a newly allocated buffer containing harbour version
Syntax
C Prototype
#include <hbapi.h> hb_verHarbour( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_verPlatform()
Retrieves a newly allocated buffer containing platform version
Syntax
C Prototype
#include <hbapi.h> hb_verPlatform( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmIsLocalRef()
Hvm.c - mark all local variables as used
Syntax
C Prototype
#include <hbapi.h> hb_vmIsLocalRef( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmIsStaticRef()
Hvm.c - mark all static variables as used
Syntax
C Prototype
#include <hbapi.h> hb_vmIsStaticRef( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xalloc()
Allocates memory, returns NULL on failure
Syntax
C Prototype
#include <hbapi.h> hb_xalloc( ULONG ulSize ) --> ( void * )pResult
Argument(s)
<ulSize>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xexit()
Deinitialize fixed memory subsystem
Syntax
C Prototype
#include <hbapi.h> hb_xexit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xfree()
Frees memory
Syntax
C Prototype
#include <hbapi.h> hb_xfree( void * pMem )
Argument(s)
<pMem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xgrab()
Allocates memory, exits on failure
Syntax
C Prototype
#include <hbapi.h> hb_xgrab( ULONG ulSize ) --> ( void * )pResult
Argument(s)
<ulSize>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xinit()
Initialize fixed memory subsystem
Syntax
C Prototype
#include <hbapi.h> hb_xinit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xmemcpy()
Copy more than memcpy() can
Syntax
C Prototype
#include <hbapi.h> hb_xmemcpy( void * pDestArg, void * pSourceArg,
ULONG ulLen ) --> ( void * )pResult
Argument(s)
<pDestArg>
<pSourceArg>
<ulLen>
Returns
<pResult>
Description
If UINT_MAX is defined as ULONG_MAX then this function is replaced by
a macro replacement to memcpy()
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xmemset()
Set more than memset() can
Syntax
C Prototype
#include <hbapi.h> hb_xmemset( void * pDestArg, int iFill, ULONG
ulLen ) --> ( void * )pResult
Argument(s)
<pDestArg>
<iFill>
<ulLen>
Returns
<pResult>
Description
If UINT_MAX is defined as ULONG_MAX then this function is replaced by
a macro replacement to memset()
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xquery()
Query different types of memory information
Syntax
C Prototype
#include <hbapi.h> hb_xquery( USHORT uiMode ) --> ( ULONG )ulResult
Argument(s)
<uiMode>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xrealloc()
Reallocates memory
Syntax
C Prototype
#include <hbapi.h> hb_xrealloc( void * pMem, ULONG ulSize ) --> (
void * )pResult
Argument(s)
<pMem>
<ulSize>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_xsize()
Returns the size of an allocated memory block
Syntax
C Prototype
#include <hbapi.h> hb_xsize( void * pMem ) --> ( ULONG )ulResult
Argument(s)
<pMem>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
FileSys
hb_fsChDir()
Change working directory
Syntax
C Prototype
#include "hbapifs.h" hb_fsChDir( BYTE * pszDirName ) --> ( HB_BOOL
)bResult
Argument(s)
<pszDirName>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsChDrv()
Change working drive
Syntax
C Prototype
#include "hbapifs.h" hb_fsChDrv( BYTE nDrive ) --> ( USHORT )usResult
Argument(s)
<nDrive>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsClose()
Close a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsClose( HB_FHANDLE hFileHandle )
Argument(s)
<hFileHandle>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCommit()
Commit updates of a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsCommit( HB_FHANDLE hFileHandle )
Argument(s)
<hFileHandle>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCreate()
Create a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsCreate( BYTE * pszFileName, USHORT
uiAttribute ) --> ( HB_FHANDLE )hResult
Argument(s)
<pszFileName>
<uiAttribute>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCreateTemp()
Create a temporary file from components
Syntax
C Prototype
#include "hbapifs.h" hb_fsCreateTemp( const BYTE * pszDir, const BYTE
* pszPrefix, USHORT uiAttribute ) --> ( HB_FHANDLE )hResult
Argument(s)
<pszDir>
<pszPrefix>
<uiAttribute>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCurDir()
Retrieve a static pointer containing current directory for specified
drive
Syntax
C Prototype
#include "hbapifs.h" hb_fsCurDir( USHORT uiDrive ) --> ( BYTE *
)pszResult
Argument(s)
<uiDrive>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCurDirBuff()
Copy current directory for given drive into a buffer
Syntax
C Prototype
#include "hbapifs.h" hb_fsCurDirBuff( USHORT uiDrive, BYTE *
pbyBuffer, HB_SIZE ulLen ) --> ( USHORT )usResult
Argument(s)
<uiDrive>
<pbyBuffer>
<ulLen>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsCurDrv()
Retrieve current drive number
Syntax
C Prototype
#include "hbapifs.h" hb_fsCurDrv( void ) --> ( BYTE )cResult
Returns
<cResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsDelete()
Delete a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsDelete( BYTE * pszFileName ) --> ( int
)iResult
Argument(s)
<pszFileName>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsEof()
Determine if an open file is position at end-of-file
Syntax
C Prototype
#include "hbapifs.h" hb_fsEof( HB_FHANDLE hFileHandle ) --> ( HB_BOOL
)bResult
Argument(s)
<hFileHandle>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsError()
Retrieve file system error
Syntax
C Prototype
#include "hbapifs.h" hb_fsError( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsExtOpen()
Open a file using default extension and a list of paths
Syntax
C Prototype
#include "hbapifs.h" hb_fsExtOpen( BYTE * pszFileName, BYTE * pDefExt,
USHORT uiFlags, BYTE * pPaths, PHB_ITEM pError ) --> ( HB_FHANDLE
)hResult
Argument(s)
<pszFileName>
<pDefExt>
<uiFlags>
<pPaths>
<pError>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsFLock()
Syntax
C Prototype (macro definition)
#include "hbapifs.h" hb_fsFLock( h, s, l ) --> <see hb_fsLock( h, s,
l, FL_LOCK )>
Argument(s)
<h>
<s>
<l>
Returns
<see hb_fsLock( h, s, l, FL_LOCK )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapifs.h
Index
C level API
hb_fsFNameMerge()
This function joins path, name and extension into a string with a
filename
Syntax
C Prototype
#include "hbapifs.h" hb_fsFNameMerge( char * pszFileName, PHB_FNAME
pFileName ) --> ( char * )pszResult
Argument(s)
<pszFileName>
<pFileName>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsFNameSplit()
Split given filename into path, name and extension
Syntax
C Prototype
#include "hbapifs.h" hb_fsFNameSplit( char * pszFileName ) --> (
PHB_FNAME )hResult
Argument(s)
<pszFileName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsFSize()
Determine the size of a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsFSize( BYTE * pszFileName, HB_BOOL
bUseDirEntry ) --> ( HB_FOFFSET )ulResult
Argument(s)
<pszFileName>
<bUseDirEntry>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsFUnlock()
Syntax
C Prototype (macro definition)
#include "hbapifs.h" hb_fsFUnlock( h, s, l ) --> <see hb_fsLock( h, s,
l, FL_UNLOCK )>
Argument(s)
<h>
<s>
<l>
Returns
<see hb_fsLock( h, s, l, FL_UNLOCK )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapifs.h
Index
C level API
hb_fsFile()
Determine if a file exists
Syntax
C Prototype
#include "hbapifs.h" hb_fsFile( BYTE * pszFileName ) --> ( HB_BOOL
)bResult
Argument(s)
<pszFileName>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsIsDevice()
Determine if a file is attached to a device (console?)
Syntax
C Prototype
#include "hbapifs.h" hb_fsIsDevice( HB_FHANDLE hFileHandle ) --> (
HB_BOOL )bResult
Argument(s)
<hFileHandle>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsIsDrv()
Determine if a drive number is a valid drive
Syntax
C Prototype
#include "hbapifs.h" hb_fsIsDrv( BYTE nDrive ) --> ( USHORT )usResult
Argument(s)
<nDrive>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsLock()
Request a lock on a portion of a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsLock( HB_FHANDLE hFileHandle, HB_SIZE
ulStart, HB_SIZE ulLength, USHORT uiMode ) --> ( HB_BOOL )bResult
Argument(s)
<hFileHandle>
<ulStart>
<ulLength>
<uiMode>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsMkDir()
Create a directory
Syntax
C Prototype
#include "hbapifs.h" hb_fsMkDir( BYTE * pszDirName ) --> ( HB_BOOL
)bResult
Argument(s)
<pszDirName>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsOpen()
Open a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsOpen( BYTE * pszFileName, USHORT uiFlags )
--> ( HB_FHANDLE )hResult
Argument(s)
<pszFileName>
<uiFlags>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsRead()
Read contents of a file into a buffer (<=64K)
Syntax
C Prototype
#include "hbapifs.h" hb_fsRead( HB_FHANDLE hFileHandle, BYTE * pBuff,
USHORT ulCount ) --> ( USHORT )usResult
Argument(s)
<hFileHandle>
<pBuff>
<ulCount>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsReadLarge()
Read contents of a file into a buffer (>64K)
Syntax
C Prototype
#include "hbapifs.h" hb_fsReadLarge( HB_FHANDLE hFileHandle, BYTE *
pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult
Argument(s)
<hFileHandle>
<pBuff>
<ulCount>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsRename()
Rename a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsRename( BYTE * pszOldName, BYTE *
pszNewName ) --> ( int )iResult
Argument(s)
<pszOldName>
<pszNewName>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsRmDir()
Remove a directory
Syntax
C Prototype
#include "hbapifs.h" hb_fsRmDir( BYTE * pszDirName ) --> ( HB_BOOL
)bResult
Argument(s)
<pszDirName>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsSeekLarge()
Reposition an open file
Syntax
C Prototype
#include "hbapifs.h" hb_fsSeekLarge( HB_FHANDLE hFileHandle,
HB_FOFFSET lOffset, USHORT uiMode ) --> ( HB_FOFFSET )ulResult
Argument(s)
<hFileHandle>
<lOffset>
<uiMode>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsSetDevMode()
Change the device mode of a file (text/binary)
Syntax
C Prototype
#include "hbapifs.h" hb_fsSetDevMode( HB_FHANDLE hFileHandle, int
iDevMode ) --> int
Argument(s)
<hFileHandle>
<iDevMode>
Returns
previous mode or -1 on error
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsSetDevRaw()
Change the device mode of a file to raw (binary)
Syntax
C Prototype
#include "hbapifs.h" hb_fsSetDevRaw( HB_FHANDLE hFileHandle )
Argument(s)
<hFileHandle>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsSetDevText()
Change the device mode of a file to text
Syntax
C Prototype
#include "hbapifs.h" hb_fsSetDevText( HB_FHANDLE hFileHandle )
Argument(s)
<hFileHandle>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsSetError()
Set the file system error number
Syntax
C Prototype
#include "hbapifs.h" hb_fsSetError( USHORT uiError )
Argument(s)
<uiError>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsTell()
Retrieve the current position of a file
Syntax
C Prototype
#include "hbapifs.h" hb_fsTell( HB_FHANDLE hFileHandle ) --> (
HB_FOFFSET )ulResult
Argument(s)
<hFileHandle>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsTempName()
Create a temporary file name in a buffer
Syntax
C Prototype
#include "hbapifs.h" hb_fsTempName( BYTE * pszBuffer, const BYTE *
pszDir, const BYTE * pszPrefix )
Argument(s)
<pszBuffer>
<pszDir>
<pszPrefix>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsWrite()
Write to an open file from a buffer (<=64K)
Syntax
C Prototype
#include "hbapifs.h" hb_fsWrite( HB_FHANDLE hFileHandle, BYTE * pBuff,
USHORT ulCount ) --> ( USHORT )usResult
Argument(s)
<hFileHandle>
<pBuff>
<ulCount>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_fsWriteLarge()
Write to an open file from a buffer (>64K)
Syntax
C Prototype
#include "hbapifs.h" hb_fsWriteLarge( HB_FHANDLE hFileHandle, BYTE *
pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult
Argument(s)
<hFileHandle>
<pBuff>
<ulCount>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
Idle states
hb_idleState()
Evaluates a single background task and calls the garbage collector.
Syntax
void hb_idleState( void );
Argument(s)
None
Description
hb_idleState() is a C function that requests garbage collection and
executes a single background task defined by the codeblock passed
with HB_IDLEADD() function. It also releases the CPU time slices for
platforms that require it.
Every call for this function evaluates different task in the order of
task creation. There are no arguments passed during codeblock
evaluation.
This function can be safely called even if there are no background
tasks defined.
This function is automatically called from the INKEY() function.
Status
Ready
Compliance
This is Harbour specific
Platform(s)
This is available on all platforms
File(s)
src/rtl/idle.c
See also
HB_IDLEADD(),HB_IDLEDEL(),HB_IDLESTATE()
Index
C level API
Item
hb_evalLaunch()
Syntax
C Prototype
#include <hbapiitm.h> hb_evalLaunch( PHB_EVALINFO pEvalInfo ) --> (
PHB_ITEM )pResult
Argument(s)
<pEvalInfo>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_evalNew()
Syntax
C Prototype
#include <hbapiitm.h> hb_evalNew( PHB_EVALINFO pEvalInfo, PHB_ITEM
pItem ) --> ( HB_BOOL ) bResult
Argument(s)
<pEvalInfo>
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_evalPutParam()
Syntax
C Prototype
#include <hbapiitm.h> hb_evalPutParam( PHB_EVALINFO pEvalInfo,
PHB_ITEM pItem ) --> ( HB_BOOL ) bResult
Argument(s)
<pEvalInfo>
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_evalRelease()
Syntax
C Prototype
#include <hbapiitm.h> hb_evalRelease( PHB_EVALINFO pEvalInfo ) --> (
HB_BOOL ) bResult
Argument(s)
<pEvalInfo>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemArrayGet()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemArrayGet( PHB_ITEM pArray, ULONG ulIndex
) --> ( PHB_ITEM )pResult
Argument(s)
<pArray>
<ulIndex>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemArrayNew()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemArrayNew( ULONG ulLen ) --> ( PHB_ITEM
)pResult
Argument(s)
<ulLen>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemArrayPut()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemArrayPut( PHB_ITEM pArray, ULONG ulIndex,
PHB_ITEM pItem ) --> ( PHB_ITEM )pResult
Argument(s)
<pArray>
<ulIndex>
<pItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemClear()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemClear( PHB_ITEM pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemCopy()
Copies an item to one place to another respecting its containts
Syntax
C Prototype
#include <hbapiitm.h> hb_itemCopy( PHB_ITEM pDest, PHB_ITEM pSource )
Argument(s)
<pDest>
<pSource>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemCopyC()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemCopyC( PHB_ITEM pItem, char * szBuffer,
ULONG ulLen ) --> ( ULONG )ulResult
Argument(s)
<pItem>
<szBuffer>
<ulLen>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemDo()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemDo( PHB_ITEM pItem, USHORT uiPCount,
PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<uiPCount>
<pItemArg1>
<...>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemDoC()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemDoC( char * szFunc, USHORT uiPCount,
PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult
Argument(s)
<szFunc>
<uiPCount>
<pItemArg1>
<...>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemFreeC()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemFreeC( char * szText ) --> ( HB_BOOL )
bResult
Argument(s)
<szText>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetC()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetC( PHB_ITEM pItem ) --> ( char *
)pszResult
Argument(s)
<pItem>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetCLen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetCLen( PHB_ITEM pItem ) --> ( ULONG
)ulResult
Argument(s)
<pItem>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetCPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetCPtr( PHB_ITEM pItem ) --> ( char *
)pszResult
Argument(s)
<pItem>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetDL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetDL( PHB_ITEM pItem ) --> ( long
)lResult
Argument(s)
<pItem>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetDS()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetDS( PHB_ITEM pItem, char * szDate )
--> ( char * )pszResult
Argument(s)
<pItem>
<szDate>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetL( PHB_ITEM pItem ) --> ( HB_BOOL )
bResult
Argument(s)
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetND()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetND( PHB_ITEM pItem ) --> ( double
)dResult
Argument(s)
<pItem>
Returns
<dResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetNI()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetNI( PHB_ITEM pItem ) --> ( int
)iResult
Argument(s)
<pItem>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetNL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetNL( PHB_ITEM pItem ) --> ( long
)lResult
Argument(s)
<pItem>
Returns
<lResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetNLen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetNLen( PHB_ITEM pItem, int * piWidth,
int * piDec )
Argument(s)
<pItem>
<piWidth>
<piDec>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemGetPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemGetPtr( PHB_ITEM pItem ) --> ( void *
)pResult
Argument(s)
<pItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemInit()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemInit( PHB_ITEM pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemNew()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemNew( PHB_ITEM pNull ) --> ( PHB_ITEM
)pResult
Argument(s)
<pNull>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPCount()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPCount( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPadConv()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPadConv( PHB_ITEM pItem, char * buffer,
ULONG * pulSize ) --> ( char * )pszResult
Argument(s)
<pItem>
<buffer>
<pulSize>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemParam()
Creates a copy of an item parameter (outside the eval stack)
Syntax
C Prototype
#include <hbapiitm.h> hb_itemParam( USHORT uiParam ) --> ( PHB_ITEM
)pResult
Argument(s)
<uiParam> The 1-based parameter to copy and retrieve.
Returns
A pointer to a new copy of the specified item parameter.
Description
Use this function whenever the pointer needs to be accessed after the
current function returns; for example, if the pointer is to be copied
to a static variable or structure member for later access.
Compare to hb_param(), which simply gets a direct pointer to the item
on the stack.
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
See also
hb_param()
Index
C level API
hb_itemParamPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemParamPtr( USHORT uiParam, int iMask )
--> ( PHB_ITEM )pResult
Argument(s)
<uiParam>
<iMask>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutC()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutC( PHB_ITEM pItem, char * szText )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<szText>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutCL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutCL( PHB_ITEM pItem, char * szText,
ULONG ulLen ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<szText>
<ulLen>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutCLPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutCLPtr( PHB_ITEM pItem, char * szText,
ULONG ulLen ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<szText>
<ulLen>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutCPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutCPtr( PHB_ITEM pItem, char * szText )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<szText>
<ulLen>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutD()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutD( PHB_ITEM pItem, long lYear, long
lMonth, long lDay ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<lYear>
<lMonth>
<lDay>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutDL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutDL( PHB_ITEM pItem, long lJulian )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<lJulian>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutDS()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutDS( PHB_ITEM pItem, char * szDate )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<szDate>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutL( PHB_ITEM pItem, HB_BOOL bValue )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<bValue>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutND()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutND( PHB_ITEM pItem, double dNumber )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<dNumber>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNDLen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNDLen( PHB_ITEM pItem, double dNumber,
int iWidth, int iDec ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<dNumber>
<iWidth>
<iDec>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNI()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNI( PHB_ITEM pItem, int iNumber ) -->
( PHB_ITEM )pResult
Argument(s)
<pItem>
<iNumber>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNILen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNILen( PHB_ITEM pItem, int iNumber,
int iWidth ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<iNumber>
<iWidth>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNL()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNL( PHB_ITEM pItem, long lNumber )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<lNumber>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNLLen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNLLen( PHB_ITEM pItem, long lNumber,
int iWidth ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<lNumber>
<iWidth>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutNLen()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutNLen( PHB_ITEM pItem, double dNumber,
int iWidth, int iDec ) --> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<dNumber>
<iWidth>
<iDec>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemPutPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemPutPtr( PHB_ITEM pItem, void * pValue )
--> ( PHB_ITEM )pResult
Argument(s)
<pItem>
<pValue>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemRelease()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemRelease( PHB_ITEM pItem ) --> ( HB_BOOL
) bResult
Argument(s)
<pItem>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemReturn()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemReturn( PHB_ITEM pItem ) --> ( PHB_ITEM
)pResult
Argument(s)
<pItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemReturnPtr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemReturnPtr( void ) --> ( PHB_ITEM )pResult
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemSetCMemo()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemSetCMemo( PHB_ITEM pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemSize()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemSize( PHB_ITEM pItem ) --> ( ULONG
)ulResult
Argument(s)
<pItem>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemStr()
Convert a number to a string
Syntax
C Prototype
#include <hbapiitm.h> hb_itemStr( PHB_ITEM pNumber, PHB_ITEM pWidth,
PHB_ITEM pDec ) --> ( char * )pszResult
Argument(s)
<pNumber>
<pWidth>
<pDec>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemStrCmp()
Our string compare
Syntax
C Prototype
#include <hbapiitm.h> hb_itemStrCmp( PHB_ITEM pFirst, PHB_ITEM
pSecond, HB_BOOL bForceExact ) --> ( int )iResult
Argument(s)
<pFirst>
<pSecond>
<bForceExact>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemString()
Convert any scalar to a string
Syntax
C Prototype
#include <hbapiitm.h> hb_itemString( PHB_ITEM pItem, ULONG * ulLen,
HB_BOOL * bFreeReq ) --> ( char * )pszResult
Argument(s)
<pItem>
<ulLen>
<bFreeReq>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemSwap()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemSwap( PHB_ITEM pItem1, PHB_ITEM pItem2 )
Argument(s)
<pItem1>
<pItem2>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemType()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemType( PHB_ITEM pItem ) --> ( USHORT
)usResult
Argument(s)
<pItem>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemTypeStr()
Syntax
C Prototype
#include <hbapiitm.h> hb_itemTypeStr( PHB_ITEM pItem ) --> ( char *
)pszResult
Argument(s)
<pItem>
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemUnRef()
De-references passed variable
Syntax
C Prototype
#include <hbapiitm.h> hb_itemUnRef( PHB_ITEM pItem ) --> ( PHB_ITEM
)pResult
Argument(s)
<pItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
hb_itemValToStr()
Convert any scalar to a string
Syntax
C Prototype
#include <hbapiitm.h> hb_itemValToStr( PHB_ITEM pItem ) --> (
PHB_ITEM )pResult
Argument(s)
<pItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rtl
Index
C level API
Macro
hb_compCodeBlockEnd()
Syntax
C Prototype
#include <hbmacro.h> hb_compCodeBlockEnd( HB_BISON_PTR pMacro )
Argument(s)
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compCodeBlockStart()
Syntax
C Prototype
#include <hbmacro.h> hb_compCodeBlockStart( HB_BISON_PTR pMacro )
Argument(s)
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenJump()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenJump( LONG lOffset, HB_BISON_PTR
pMacro ) --> ( ULONG )ulResult
Argument(s)
<lOffset>
<pMacro>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenJumpFalse()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenJumpFalse( LONG lOffset, HB_BISON_PTR
pMacro ) --> ( ULONG )ulResult
Argument(s)
<lOffset>
<pMacro>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenJumpHere()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenJumpHere( ULONG ulOffset, HB_BISON_PTR
pMacro )
Argument(s)
<ulOffset>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenJumpThere()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenJumpThere( ULONG ulFrom, ULONG ulTo,
HB_BISON_PTR pMacro )
Argument(s)
<ulFrom>
<ulTo>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenJumpTrue()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenJumpTrue( LONG lOffset, HB_BISON_PTR
pMacro ) --> ( ULONG )ulResult
Argument(s)
<lOffset>
<pMacro>
Returns
<ulResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenMessage()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenMessage( char * szMsgName,
HB_BISON_PTR pMacro )
Argument(s)
<szMsgName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenMessageData()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenMessageData( char * szMsg,
HB_BISON_PTR pMacro )
Argument(s)
<szMsg>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPCode1()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPCode1( BYTE byte, HB_BISON_PTR pMacro
)
Argument(s)
<byte>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPCode2()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPCode2( BYTE byte1, BYTE byte2,
HB_BISON_PTR pMacro )
Argument(s)
<byte1>
<byte2>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPCode3()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPCode3( BYTE byte1, BYTE byte2, BYTE
byte3, HB_BISON_PTR pMacro )
Argument(s)
<byte1>
<byte2>
<byte3>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPCode4()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPCode4( BYTE byte1, BYTE byte2, BYTE
byte3, BYTE byte4, HB_BISON_PTR pMacro )
Argument(s)
<byte1>
<byte2>
<byte3>
<byte4>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPCodeN()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPCodeN( BYTE * pBuffer, ULONG ulSize,
HB_BISON_PTR pMacro )
Argument(s)
<pBuffer>
<ulSize>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPopAliasedVar()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPopAliasedVar( char * szVarName,
HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR
pMacro )
Argument(s)
<szVarName>
<bPushAliasValue>
<szAlias>
<lWorkarea>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPopVar()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPopVar( char * szVarName, HB_BISON_PTR
pMacro )
Argument(s)
<szVarName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushAliasedVar()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushAliasedVar( char * szVarName,
HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR
pMacro )
Argument(s)
<szVarName>
<bPushAliasValue>
<szAlias>
<lWorkarea>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushDouble()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushDouble( double dNumber, BYTE
bWidth, BYTE bDec, HB_BISON_PTR pMacro )
Argument(s)
<dNumber>
<bWidth>
<bDec>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushFunCall()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushFunCall( char * szFunName,
HB_BISON_PTR pMacro )
Argument(s)
<szFunName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushLogical()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushLogical( int iTrueFalse,
HB_BISON_PTR pMacro )
Argument(s)
<iTrueFalse>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushLong()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushLong( long lNumber, HB_BISON_PTR
pMacro )
Argument(s)
<lNumber>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushString()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushString( char * szText, ULONG
ulStrLen, HB_BISON_PTR pMacro )
Argument(s)
<szText>
<ulStrLen>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushSymbol()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushSymbol( char * szSymbolName, int
isFunction, HB_BISON_PTR pMacro )
Argument(s)
<szSymbolName>
<isFunction>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushVar()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushVar( char * szVarName,
HB_BISON_PTR pMacro )
Argument(s)
<szVarName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compGenPushVarRef()
Syntax
C Prototype
#include <hbmacro.h> hb_compGenPushVarRef( char * szVarName,
HB_BISON_PTR pMacro )
Argument(s)
<szVarName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compLocalVarGetPos()
Syntax
C Prototype
#include <hbmacro.h> hb_compLocalVarGetPos( char * szVarName,
HB_BISON_PTR pMacro ) --> ( int )iResult
Argument(s)
<szVarName>
<pMacro>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_compMemvarGenPCode()
Syntax
C Prototype
#include <hbmacro.h> hb_compMemvarGenPCode( BYTE bPCode, char *
szVarName, HB_BISON_PTR pMacro )
Argument(s)
<bPCode>
<szVarName>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_macroError()
Syntax
C Prototype
#include <hbmacro.h> hb_macroError( int iError, HB_BISON_PTR pMacro )
Argument(s)
<iError>
<pMacro>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
hb_macroYYParse()
Syntax
C Prototype
#include <hbmacro.h> hb_macroYYParse( HB_MACRO_PTR pMacro ) --> ( int
)iResult
Argument(s)
<pMacro>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is macro
Index
C level API
Math
hb_mathGetErrMode()
get math error handling mode
Syntax
C Prototype
#include <hbmath.h> hb_mathGetErrMode (void) --> imode
Returns
imode math error handling mode
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
See also
hb_mathSetErrMode()
Index
C level API
hb_mathGetHandler()
get current Harbour math error handler
Syntax
C Prototype
#include <hbmath.h> hb_mathGetHandler (void) --> HB_MATH_HANDLERPROC
handlerproc
Argument(s)
handlerproc custom math handler
typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err)
Returns
<handerproc>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
Index
C level API
hb_mathGetLastError()
get the last math lib error
Syntax
C Prototype
#include <hbmath.h> hb_mathGetLastError (HB_MATH_EXCEPTION * phb_exc)
--> int iMathErrorType
Argument(s)
phb_exc pointer to HB_MATH_EXCEPTION structure, if not NULL,
the structure will be filled with information about the last math
error:
typedef struct _HB_MATH_EXCEPTION {
int type; // Math error type, is one of the constants
// HB_MATH_ERR_xxx defined in hbmath.ch
char *funcname; // Pointer to name of the math C RTL routine
// that caused the error.
char *error; // Pointer to error description. double arg1; //
First and double arg2; // Second double argument to the math
routine. double retval; // Corrected return value for the math
routine. int retvalwidth; // Width and int retvaldec; // Decimals
of the corrected return value,
// both default to -1
int handled; // 1, if the math error is already corrected,
// 0 otherwise.
} HB_MATH_EXCEPTION;
Returns
<iMathErrorType>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
Index
C level API
hb_mathIsMathErr()
Check if harbour math error handling is available
Syntax
C Prototype
#include <hbmath.h> hb_mathIsMathErr (void) --> int iIsMathHandler
Returns
<iIsMathHandler>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
Index
C level API
hb_mathResetError()
Reset the internal math error information structure
Syntax
C Prototype
#include <hbmath.h> hb_mathResetError (void)
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
Index
C level API
hb_mathSetErrMode()
set math error handling mode
Syntax
C Prototype
#include <hbmath.h> hb_mathSetErrMode (int imode) --> int ioldmode
Argument(s)
imode math error handling mode, one of the following
constants, defined in hbmath.ch:
HB_MATH_ERRMODE_DEFAULT HB_MATH_ERRMODE_CDEFAULT HB_MATH_ERRMODE_USER
HB_MATH_ERRMODE_USERDEFAULT HB_MATH_ERRMODE_USERCDEFAULT
Returns
ioldmode old math error handling mode
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
See also
hb_mathGetErrMode()
Index
C level API
hb_mathSetHandler()
set the harbour math handler
Syntax
C Prototype
#include <hbmath.h> hb_mathSetHandler (HB_MATH_HANDLERPROC
handlerproc)
--> HB_MATH_HANDLERPROC previous_handerproc
Argument(s)
handlerproc custom math handler
typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err)
Returns
previous_handlerproc previous math handler
typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err)
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbmath.h Library is rtl
Index
C level API
RDD
SELF_ADDFIELD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ADDFIELD( w, ip ) --> <see ( ( *( w
)->lprfsHost->addField )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->addField )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ALIAS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ALIAS( w, bp ) --> <see ( ( *( w
)->lprfsHost->alias )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->alias )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_APPEND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_APPEND( w, l ) --> <see ( ( *( w
)->lprfsHost->append )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->append )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_BOF()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_BOF( w, sp ) --> <see ( ( *( w
)->lprfsHost->bof )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->bof )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CHILDEND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CHILDEND( w, ip ) --> <see ( ( *( w
)->lprfsHost->childEnd )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->childEnd )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CHILDSTART()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CHILDSTART( w, ip ) --> <see ( ( *( w
)->lprfsHost->childStart )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->childStart )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CHILDSYNC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CHILDSYNC( w, ip ) --> <see ( ( *( w
)->lprfsHost->childSync )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->childSync )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLEARFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLEARFILTER( w ) --> <see ( ( *( w
)->lprfsHost->clearFilter )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->clearFilter )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLEARLOCATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLEARLOCATE( w ) --> <see ( ( *( w
)->lprfsHost->clearLocate )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->clearLocate )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLEARREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLEARREL( w ) --> <see ( ( *( w
)->lprfsHost->clearRel )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->clearRel )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLEARSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLEARSCOPE( w ) --> <see ( ( *( w
)->lprfsHost->clearScope )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->clearScope )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLOSE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLOSE( w ) --> <see ( ( *( w
)->lprfsHost->close )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->close )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CLOSEMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CLOSEMEMFILE( w ) --> <see ( ( *( w
)->lprfsHost->closeMemFile )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->closeMemFile )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_COMPILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_COMPILE( w, bp ) --> <see ( ( *( w
)->lprfsHost->compile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->compile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_COUNTSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_COUNTSCOPE( w, ip, lp ) --> <see ( ( *( w
)->lprfsHost->countScope )( w, ip, lp ) )>
Argument(s)
<w>
<ip>
<lp>
Returns
<see ( ( *( w )->lprfsHost->countScope )( w, ip, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CREATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CREATE( w, ip ) --> <see ( ( *( w
)->lprfsHost->create )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->create )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CREATEFIELDS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CREATEFIELDS( w, v ) --> <see ( ( *( w
)->lprfsHost->createFields )( w, v ) )>
Argument(s)
<w>
<v>
Returns
<see ( ( *( w )->lprfsHost->createFields )( w, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_CREATEMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_CREATEMEMFILE( w, bp ) --> <see ( ( *( w
)->lprfsHost->createMemFile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->createMemFile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_DBEVAL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_DBEVAL( w, ip ) --> <see ( ( *( w
)->lprfsHost->dbEval )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->dbEval )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_DELETE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_DELETE( w ) --> <see ( ( *( w
)->lprfsHost->deleterec )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->deleterec )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_DELETED()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_DELETED( w, sp ) --> <see ( ( *( w
)->lprfsHost->deleted )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->deleted )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_EOF()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_EOF( w, sp ) --> <see ( ( *( w
)->lprfsHost->eof )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->eof )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ERROR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ERROR( w, ip ) --> <see ( ( *( w
)->lprfsHost->error )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->error )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_EVALBLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_EVALBLOCK( w, v ) --> <see ( ( *( w
)->lprfsHost->evalBlock )( w, v ) )>
Argument(s)
<w>
<v>
Returns
<see ( ( *( w )->lprfsHost->evalBlock )( w, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FIELDCOUNT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FIELDCOUNT( w, sp ) --> <see ( ( *( w
)->lprfsHost->fieldCount )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->fieldCount )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FIELDDISPLAY()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FIELDDISPLAY( w, sp ) --> <see ( ( *( w
)->lprfsHost->fieldDisplay )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->fieldDisplay )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FIELDINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FIELDINFO( w, s1, s2, v ) --> <see ( ( *(
w )->lprfsHost->fieldInfo )( w, s1, s2, v ) )>
Argument(s)
<w>
<s1>
<s2>
<v>
Returns
<see ( ( *( w )->lprfsHost->fieldInfo )( w, s1, s2, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FIELDNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FIELDNAME( w, i, bp ) --> <see ( ( *( w
)->lprfsHost->fieldName )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( w )->lprfsHost->fieldName )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FILTERTEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FILTERTEXT( w, bp ) --> <see ( ( *( w
)->lprfsHost->filterText )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->filterText )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FLUSH()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FLUSH( w ) --> <see ( ( *( w
)->lprfsHost->flush )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->flush )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FORCEREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FORCEREL( w ) --> <see ( ( *( w
)->lprfsHost->forceRel )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->forceRel )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_FOUND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_FOUND( w, sp ) --> <see ( ( *( w
)->lprfsHost->found )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->found )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETDELIM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETDELIM( w, fp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETLOCKS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETLOCKS( w, g ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )>
Argument(s)
<w>
<g>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETREC( w, bpp ) --> <see ( ( *( w
)->lprfsHost->getRec )( w, bpp ) )>
Argument(s)
<w>
<bpp>
Returns
<see ( ( *( w )->lprfsHost->getRec )( w, bpp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETVALUE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETVALUE( w, i, v ) --> <see ( ( *( w
)->lprfsHost->getValue )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( w )->lprfsHost->getValue )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETVALUEFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETVALUEFILE( w, i, bp ) --> <see ( ( *( w
)->lprfsHost->getValueFile )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( w )->lprfsHost->getValueFile )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GETVARLEN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GETVARLEN( w, i, lp ) --> <see ( ( *( w
)->lprfsHost->getVarLen )( w, i, lp ) )>
Argument(s)
<w>
<i>
<lp>
Returns
<see ( ( *( w )->lprfsHost->getVarLen )( w, i, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOBOTTOM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOBOTTOM( w ) --> <see ( ( *( w
)->lprfsHost->goBottom )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->goBottom )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOCOLD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOCOLD( w ) --> <see ( ( *( w
)->lprfsHost->goCold )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->goCold )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOHOT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOHOT( w ) --> <see ( ( *( w
)->lprfsHost->goHot )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->goHot )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOTO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOTO( w, l ) --> <see ( ( *( w
)->lprfsHost->go )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->go )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOTOID()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOTOID( w, sp ) --> <see ( ( *( w
)->lprfsHost->goToId )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->goToId )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_GOTOP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_GOTOP( w ) --> <see ( ( *( w
)->lprfsHost->goTop )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->goTop )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_HEADERSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_HEADERSIZE( w, fp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_INFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_INFO( w, i, g ) --> <see ( ( *( w
)->lprfsHost->info )( w, i, g ) )>
Argument(s)
<w>
<i>
<g>
Returns
<see ( ( *( w )->lprfsHost->info )( w, i, g ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_LOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_LOCK( w, sp ) --> <see ( ( *( w
)->lprfsHost->lock )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->lock )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_LUPDATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_LUPDATE( w, fp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_NEW()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_NEW( w ) --> <see ( ( *( w
)->lprfsHost->newarea )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->newarea )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_OPEN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_OPEN( w, ip ) --> <see ( ( *( w
)->lprfsHost->open )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->open )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_OPENMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_OPENMEMFILE( w, bp ) --> <see ( ( *( w
)->lprfsHost->openMemFile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->openMemFile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDBAGEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDBAGEXT( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDBAGNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDBAGNAME( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDCOND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDCOND( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDCREATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDCREATE( w, ip ) --> <see ( ( *( w
)->lprfsHost->orderCreate )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->orderCreate )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDDESTROY()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDDESTROY( w, p ) --> <see ( ( *( w
)->lprfsHost->orderDestroy )( w, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderDestroy )( w, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDEXPR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDEXPR( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDINFO( w, i, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, i, p ) )>
Argument(s)
<w>
<i>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, i, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDLSTADD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDLSTADD( w, lp ) --> <see ( ( *( w
)->lprfsHost->orderListAdd )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( w )->lprfsHost->orderListAdd )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDLSTCLEAR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDLSTCLEAR( w ) --> <see ( ( *( w
)->lprfsHost->orderListClear )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->orderListClear )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDLSTDELETE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDLSTDELETE( w, lp ) --> <see ( ( *( w
)->lprfsHost->orderListDelete )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( w )->lprfsHost->orderListDelete )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDLSTFOCUS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDLSTFOCUS( w, lp ) --> <see ( ( *( w
)->lprfsHost->orderListFocus )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( w )->lprfsHost->orderListFocus )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDLSTREBUILD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDLSTREBUILD( w ) --> <see ( ( *( w
)->lprfsHost->orderListRebuild )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->orderListRebuild )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDNAME( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_NAME, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_NAME, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDNUMBER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDNUMBER( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDPOS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDPOS( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDRECNO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDRECNO( w, p ) --> <see ( ( *( w
)->lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( w )->lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ORDSETCOND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ORDSETCOND( w, ip ) --> <see ( ( *( w
)->lprfsHost->orderCondition )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->orderCondition )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_PACK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_PACK( w ) --> <see ( ( *( w
)->lprfsHost->pack )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->pack )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_PACKREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_PACKREC( w, l, sp ) --> <see ( ( *( w
)->lprfsHost->packRec )( w, l, sp ) )>
Argument(s)
<w>
<l>
<sp>
Returns
<see ( ( *( w )->lprfsHost->packRec )( w, l, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_PUTREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_PUTREC( w, bp ) --> <see ( ( *( w
)->lprfsHost->putRec )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->putRec )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_PUTVALUE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_PUTVALUE( w, i, v ) --> <see ( ( *( w
)->lprfsHost->putValue )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( w )->lprfsHost->putValue )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_PUTVALUEFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_PUTVALUEFILE( w, i, bp ) --> <see ( ( *( w
)->lprfsHost->putValueFile )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( w )->lprfsHost->putValueFile )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RAWLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RAWLOCK( w, i, l ) --> <see ( ( *( w
)->lprfsHost->rawlock )( w, i, l ) )>
Argument(s)
<w>
<i>
<l>
Returns
<see ( ( *( w )->lprfsHost->rawlock )( w, i, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_READDBHEADER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_READDBHEADER( w ) --> <see ( ( *( w
)->lprfsHost->readDBHeader )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->readDBHeader )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RECALL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RECALL( w ) --> <see ( ( *( w
)->lprfsHost->recall )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->recall )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RECCOUNT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RECCOUNT( w, sp ) --> <see ( ( *( w
)->lprfsHost->reccount )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->reccount )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RECINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RECINFO( w, v1, i, v2 ) --> <see ( ( *( w
)->lprfsHost->recInfo )( w, v1, i, v2 ) )>
Argument(s)
<w>
<v1>
<i>
<v2>
Returns
<see ( ( *( w )->lprfsHost->recInfo )( w, v1, i, v2 ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RECNO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RECNO( w, i ) --> <see ( ( *( w
)->lprfsHost->recno )( w, i ) )>
Argument(s)
<w>
<i>
Returns
<see ( ( *( w )->lprfsHost->recno )( w, i ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RECSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RECSIZE( w, lp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RELAREA()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RELAREA( w, s, sp ) --> <see ( ( *( w
)->lprfsHost->relArea )( w, s, sp ) )>
Argument(s)
<w>
<s>
<sp>
Returns
<see ( ( *( w )->lprfsHost->relArea )( w, s, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RELEASE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RELEASE( w ) --> <see ( ( *( w
)->lprfsHost->release )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->release )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RELEVAL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RELEVAL( w, ip ) --> <see ( ( *( w
)->lprfsHost->relEval )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->relEval )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_RELTEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_RELTEXT( w, s, bp ) --> <see ( ( *( w
)->lprfsHost->relText )( w, s, bp ) )>
Argument(s)
<w>
<s>
<bp>
Returns
<see ( ( *( w )->lprfsHost->relText )( w, s, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SCOPEINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SCOPEINFO( w, i, v ) --> <see ( ( *( w
)->lprfsHost->scopeInfo )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( w )->lprfsHost->scopeInfo )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SEEK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SEEK( w, i1, v, i2 ) --> <see ( ( *( w
)->lprfsHost->seek )( w, i1, v, i2 ) )>
Argument(s)
<w>
<i1>
<v>
<i2>
Returns
<see ( ( *( w )->lprfsHost->seek )( w, i1, v, i2 ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETDELIM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETDELIM( w, fp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETFIELDEXTENT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETFIELDEXTENT( w, s ) --> <see ( ( *( w
)->lprfsHost->setFieldExtent )( w, s ) )>
Argument(s)
<w>
<s>
Returns
<see ( ( *( w )->lprfsHost->setFieldExtent )( w, s ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETFILTER( w, ip ) --> <see ( ( *( w
)->lprfsHost->setFilter )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->setFilter )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETLOCATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETLOCATE( w, ip ) --> <see ( ( *( w
)->lprfsHost->setLocate )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->setLocate )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETREL( w, ip ) --> <see ( ( *( w
)->lprfsHost->setRel )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->setRel )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SETSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SETSCOPE( w, ip ) --> <see ( ( *( w
)->lprfsHost->setScope )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->setScope )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SKIP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SKIP( w, l ) --> <see ( ( *( w
)->lprfsHost->skip )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->skip )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SKIPFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SKIPFILTER( w, l ) --> <see ( ( *( w
)->lprfsHost->skipFilter )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->skipFilter )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SKIPRAW()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SKIPRAW( w, l ) --> <see ( ( *( w
)->lprfsHost->skipRaw )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->skipRaw )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SKIPSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SKIPSCOPE( w, bp, l ) --> <see ( ( *( w
)->lprfsHost->skipScope )( w, bp, l ) )>
Argument(s)
<w>
<bp>
<l>
Returns
<see ( ( *( w )->lprfsHost->skipScope )( w, bp, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SORT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SORT( w, ip ) --> <see ( ( *( w
)->lprfsHost->sort )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->sort )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_STRUCTSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_STRUCTSIZE( w, sp ) --> <see ( ( *( w
)->lprfsHost->structSize )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( w )->lprfsHost->structSize )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SYNCCHILDREN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SYNCCHILDREN( w ) --> <see ( ( *( w
)->lprfsHost->syncChildren )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->syncChildren )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_SYSNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_SYSNAME( w, bp ) --> <see ( ( *( w
)->lprfsHost->sysName )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( w )->lprfsHost->sysName )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_TABLEEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_TABLEEXT( w, fp ) --> <see ( ( *( w
)->lprfsHost->info )( w, DBI_TABLEEXT, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( w )->lprfsHost->info )( w, DBI_TABLEEXT, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_TRANS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_TRANS( w, ip ) --> <see ( ( *( w
)->lprfsHost->trans )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->trans )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_TRANSREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_TRANSREC( w, ip ) --> <see ( ( *( w
)->lprfsHost->transRec )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( w )->lprfsHost->transRec )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_UNLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_UNLOCK( w, l ) --> <see ( ( *( w
)->lprfsHost->unlock )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( w )->lprfsHost->unlock )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_WRITEDBHEADER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_WRITEDBHEADER( w ) --> <see ( ( *( w
)->lprfsHost->writeDBHeader )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->writeDBHeader )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SELF_ZAP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SELF_ZAP( w ) --> <see ( ( *( w
)->lprfsHost->zap )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( w )->lprfsHost->zap )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ADDFIELD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ADDFIELD( w, ip ) --> <see ( ( *(
SUPERTABLE )->addField )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->addField )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ALIAS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ALIAS( w, bp ) --> <see ( ( *( SUPERTABLE
)->alias )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->alias )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_APPEND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_APPEND( w, l ) --> <see ( ( *( SUPERTABLE
)->append )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( SUPERTABLE )->append )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_BOF()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_BOF( w, sp ) --> <see ( ( *( SUPERTABLE
)->bof )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->bof )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CHILDEND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CHILDEND( w, ip ) --> <see ( ( *(
SUPERTABLE )->childEnd )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->childEnd )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CHILDSTART()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CHILDSTART( w, ip ) --> <see ( ( *(
SUPERTABLE )->childStart )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->childStart )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CHILDSYNC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CHILDSYNC( w, ip ) --> <see ( ( *(
SUPERTABLE )->childSync )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->childSync )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLEARFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLEARFILTER( w ) --> <see ( ( *(
SUPERTABLE )->clearFilter )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->clearFilter )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLEARLOCATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLEARLOCATE( w ) --> <see ( ( *(
SUPERTABLE )->clearLocate )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->clearLocate )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLEARREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLEARREL( w ) --> <see ( ( *( SUPERTABLE
)->clearRel )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->clearRel )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLEARSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLEARSCOPE( w ) --> <see ( ( *(
SUPERTABLE )->clearScope )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->clearScope )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLOSE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLOSE( w ) --> <see ( ( *( SUPERTABLE
)->close )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->close )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CLOSEMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CLOSEMEMFILE( w ) --> <see ( ( *(
SUPERTABLE )->closeMemFile )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->closeMemFile )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_COMPILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_COMPILE( w, bp ) --> <see ( ( *(
SUPERTABLE )->compile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->compile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_COUNTSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_COUNTSCOPE( w, ip, lp ) --> <see ( ( *(
SUPERTABLE )->countScope )( w, ip, lp ) )>
Argument(s)
<w>
<ip>
<lp>
Returns
<see ( ( *( SUPERTABLE )->countScope )( w, ip, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CREATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CREATE( w, ip ) --> <see ( ( *(
SUPERTABLE )->create )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->create )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CREATEFIELDS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CREATEFIELDS( w, v ) --> <see ( ( *(
SUPERTABLE )->createFields )( w, v ) )>
Argument(s)
<w>
<v>
Returns
<see ( ( *( SUPERTABLE )->createFields )( w, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_CREATEMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_CREATEMEMFILE( w, bp ) --> <see ( ( *(
SUPERTABLE )->createMemFile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->createMemFile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_DBEVAL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_DBEVAL( w, ip ) --> <see ( ( *(
SUPERTABLE )->dbEval )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->dbEval )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_DELETE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_DELETE( w ) --> <see ( ( *( SUPERTABLE
)->deleterec )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->deleterec )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_DELETED()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_DELETED( w, sp ) --> <see ( ( *(
SUPERTABLE )->deleted )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->deleted )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_EOF()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_EOF( w, sp ) --> <see ( ( *( SUPERTABLE
)->eof )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->eof )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ERROR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ERROR( w, ip ) --> <see ( ( *( SUPERTABLE
)->error )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->error )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_EVALBLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_EVALBLOCK( w, v ) --> <see ( ( *(
SUPERTABLE )->evalBlock )( w, v ) )>
Argument(s)
<w>
<v>
Returns
<see ( ( *( SUPERTABLE )->evalBlock )( w, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FIELDCOUNT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FIELDCOUNT( w, sp ) --> <see ( ( *(
SUPERTABLE )->fieldCount )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->fieldCount )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FIELDDISPLAY()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FIELDDISPLAY( w, sp ) --> <see ( ( *(
SUPERTABLE )->fieldDisplay )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->fieldDisplay )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FIELDINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FIELDINFO( w, s1, s2, v ) --> <see ( ( *(
SUPERTABLE )->fieldInfo )( w, s1, s2, v ) )>
Argument(s)
<w>
<s1>
<s2>
<v>
Returns
<see ( ( *( SUPERTABLE )->fieldInfo )( w, s1, s2, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FIELDNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FIELDNAME( w, i, bp ) --> <see ( ( *(
SUPERTABLE )->fieldName )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( SUPERTABLE )->fieldName )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FILTERTEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FILTERTEXT( w, bp ) --> <see ( ( *(
SUPERTABLE )->filterText )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->filterText )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FLUSH()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FLUSH( w ) --> <see ( ( *( SUPERTABLE
)->flush )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->flush )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FORCEREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FORCEREL( w ) --> <see ( ( *( SUPERTABLE
)->forceRel )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->forceRel )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_FOUND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_FOUND( w, sp ) --> <see ( ( *( SUPERTABLE
)->found )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->found )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETDELIM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETDELIM( w, fp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_GETDELIMITER, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_GETDELIMITER, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETLOCKS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETLOCKS( w, g ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_GETLOCKARRAY, g ) )>
Argument(s)
<w>
<g>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_GETLOCKARRAY, g ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETREC( w, bpp ) --> <see ( ( *(
SUPERTABLE )->getRec )( w, bpp ) )>
Argument(s)
<w>
<bpp>
Returns
<see ( ( *( SUPERTABLE )->getRec )( w, bpp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETVALUE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETVALUE( w, i, v ) --> <see ( ( *(
SUPERTABLE )->getValue )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( SUPERTABLE )->getValue )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETVALUEFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETVALUEFILE( w, i, bp ) --> <see ( ( *(
SUPERTABLE )->getValueFile )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( SUPERTABLE )->getValueFile )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GETVARLEN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GETVARLEN( w, i, lp ) --> <see ( ( *(
SUPERTABLE )->getVarLen )( w, i, lp ) )>
Argument(s)
<w>
<i>
<lp>
Returns
<see ( ( *( SUPERTABLE )->getVarLen )( w, i, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOBOTTOM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOBOTTOM( w ) --> <see ( ( *( SUPERTABLE
)->goBottom )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->goBottom )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOCOLD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOCOLD( w ) --> <see ( ( *( SUPERTABLE
)->goCold )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->goCold )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOHOT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOHOT( w ) --> <see ( ( *( SUPERTABLE
)->goHot )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->goHot )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOTO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOTO( w, l ) --> <see ( ( *( SUPERTABLE
)->go )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( SUPERTABLE )->go )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOTOID()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOTOID( w, sp ) --> <see ( ( *(
SUPERTABLE )->goToId )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->goToId )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_GOTOP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_GOTOP( w ) --> <see ( ( *( SUPERTABLE
)->goTop )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->goTop )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_HEADERSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_HEADERSIZE( w, fp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_GETHEADERSIZE, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_GETHEADERSIZE, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_INFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_INFO( w, i, g ) --> <see ( ( *(
SUPERTABLE )->info )( w, i, g ) )>
Argument(s)
<w>
<i>
<g>
Returns
<see ( ( *( SUPERTABLE )->info )( w, i, g ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_LOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_LOCK( w, sp ) --> <see ( ( *( SUPERTABLE
)->lock )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->lock )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_LUPDATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_LUPDATE( w, fp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_LASTUPDATE, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_LASTUPDATE, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_NEW()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_NEW( w ) --> <see ( ( *( SUPERTABLE
)->newarea )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->newarea )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_OPEN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_OPEN( w, ip ) --> <see ( ( *( SUPERTABLE
)->open )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->open )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_OPENMEMFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_OPENMEMFILE( w, bp ) --> <see ( ( *(
SUPERTABLE )->openMemFile )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->openMemFile )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDBAGEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDBAGEXT( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_BAGEXT, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_BAGEXT, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDBAGNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDBAGNAME( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_BAGNAME, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_BAGNAME, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDCOND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDCOND( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_CONDITION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_CONDITION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDCREATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDCREATE( w, ip ) --> <see ( ( *(
SUPERTABLE )->orderCreate )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->orderCreate )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDDELETE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDDELETE( w, ip ) --> <see ( ( *(
SUPERTABLE )->orderDelete )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->orderDelete )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDEXPR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDEXPR( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_EXPRESSION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_EXPRESSION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDINFO( w, i, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, i, p ) )>
Argument(s)
<w>
<i>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, i, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDLSTADD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDLSTADD( w, lp ) --> <see ( ( *(
SUPERTABLE )->orderListAdd )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( SUPERTABLE )->orderListAdd )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDLSTCLEAR()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDLSTCLEAR( w ) --> <see ( ( *(
SUPERTABLE )->orderListClear )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->orderListClear )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDLSTDELETE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDLSTDELETE( w, lp ) --> <see ( ( *(
SUPERTABLE )->orderListDelete )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( SUPERTABLE )->orderListDelete )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDLSTFOCUS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDLSTFOCUS( w, lp ) --> <see ( ( *(
SUPERTABLE )->orderListFocus )( w, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( SUPERTABLE )->orderListFocus )( w, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDLSTREBUILD()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDLSTREBUILD( w ) --> <see ( ( *(
SUPERTABLE )->orderListRebuild )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->orderListRebuild )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDNAME( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_NAME, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_NAME, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDNUMBER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDNUMBER( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_NUMBER, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_NUMBER, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDPOS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDPOS( w, p ) --> <see ( ( *( SUPERTABLE
)->orderInfo )( w, DBOI_POSITION, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_POSITION, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDRECNO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDRECNO( w, p ) --> <see ( ( *(
SUPERTABLE )->orderInfo )( w, DBOI_RECNO, p ) )>
Argument(s)
<w>
<p>
Returns
<see ( ( *( SUPERTABLE )->orderInfo )( w, DBOI_RECNO, p ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ORDSETCOND()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ORDSETCOND( w, ip ) --> <see ( ( *(
SUPERTABLE )->orderCondition )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->orderCondition )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_PACK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_PACK( w ) --> <see ( ( *( SUPERTABLE
)->pack )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->pack )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_PACKREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_PACKREC( w, l, sp ) --> <see ( ( *(
SUPERTABLE )->packRec )( w, l, sp ) )>
Argument(s)
<w>
<l>
<sp>
Returns
<see ( ( *( SUPERTABLE )->packRec )( w, l, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_PUTREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_PUTREC( w, bp ) --> <see ( ( *(
SUPERTABLE )->putRec )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->putRec )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_PUTVALUE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_PUTVALUE( w, i, v ) --> <see ( ( *(
SUPERTABLE )->putValue )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( SUPERTABLE )->putValue )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_PUTVALUEFILE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_PUTVALUEFILE( w, i, bp ) --> <see ( ( *(
SUPERTABLE )->putValueFile )( w, i, bp ) )>
Argument(s)
<w>
<i>
<bp>
Returns
<see ( ( *( SUPERTABLE )->putValueFile )( w, i, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RAWLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RAWLOCK( w, i, l ) --> <see ( ( *(
SUPERTABLE )->rawlock )( w, i, l ) )>
Argument(s)
<w>
<i>
<l>
Returns
<see ( ( *( SUPERTABLE )->rawlock )( w, i, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_READDBHEADER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_READDBHEADER( w ) --> <see ( ( *(
SUPERTABLE )->readDBHeader )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->readDBHeader )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RECALL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RECALL( w ) --> <see ( ( *( SUPERTABLE
)->recall )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->recall )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RECCOUNT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RECCOUNT( w, sp ) --> <see ( ( *(
SUPERTABLE )->reccount )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->reccount )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RECINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RECINFO( w, v1, i, v2 ) --> <see ( ( *(
SUPERTABLE )->recInfo )( w, v1, i, v2 ) )>
Argument(s)
<w>
<v1>
<i>
<v2>
Returns
<see ( ( *( SUPERTABLE )->recInfo )( w, v1, i, v2 ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RECNO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RECNO( w, sp ) --> <see ( ( *( SUPERTABLE
)->recno )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->recno )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RECSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RECSIZE( w, lp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_GETRECSIZE, lp ) )>
Argument(s)
<w>
<lp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_GETRECSIZE, lp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RELAREA()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RELAREA( w, s, sp ) --> <see ( ( *(
SUPERTABLE )->relArea )( w, s, sp ) )>
Argument(s)
<w>
<s>
<sp>
Returns
<see ( ( *( SUPERTABLE )->relArea )( w, s, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RELEASE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RELEASE( w ) --> <see ( ( *( SUPERTABLE
)->release )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->release )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RELEVAL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RELEVAL( w, ip ) --> <see ( ( *(
SUPERTABLE )->relEval )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->relEval )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_RELTEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_RELTEXT( w, s, bp ) --> <see ( ( *(
SUPERTABLE )->relText )( w, s, bp ) )>
Argument(s)
<w>
<s>
<bp>
Returns
<see ( ( *( SUPERTABLE )->relText )( w, s, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SCOPEINFO()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SCOPEINFO( w, i, v ) --> <see ( ( *(
SUPERTABLE )->scopeInfo )( w, i, v ) )>
Argument(s)
<w>
<i>
<v>
Returns
<see ( ( *( SUPERTABLE )->scopeInfo )( w, i, v ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SEEK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SEEK( w, i1, v, i2 ) --> <see ( ( *(
SUPERTABLE )->seek )( w, i1, v, i2 ) )>
Argument(s)
<w>
<i1>
<v>
<i2>
Returns
<see ( ( *( SUPERTABLE )->seek )( w, i1, v, i2 ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETDELIM()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETDELIM( w, fp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_SETDELIMITER, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_SETDELIMITER, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETFIELDEXTENT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETFIELDEXTENT( w, s ) --> <see ( ( *(
SUPERTABLE )->setFieldExtent )( w, s ) )>
Argument(s)
<w>
<s>
Returns
<see ( ( *( SUPERTABLE )->setFieldExtent )( w, s ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETFILTER( w, ip ) --> <see ( ( *(
SUPERTABLE )->setFilter )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->setFilter )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETLOCATE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETLOCATE( w, ip ) --> <see ( ( *(
SUPERTABLE )->setLocate )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->setLocate )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETREL()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETREL( w, ip ) --> <see ( ( *(
SUPERTABLE )->setRel )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->setRel )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SETSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SETSCOPE( w, ip ) --> <see ( ( *(
SUPERTABLE )->setScope )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->setScope )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SKIP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SKIP( w, l ) --> <see ( ( *( SUPERTABLE
)->skip )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( SUPERTABLE )->skip )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SKIPFILTER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SKIPFILTER( w, l ) --> <see ( ( *(
SUPERTABLE )->skipFilter )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( SUPERTABLE )->skipFilter )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SKIPRAW()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SKIPRAW( w, l ) --> <see ( ( *(
SUPERTABLE )->skipRaw )( w, l ) )>
Argument(s)
<w>
<l>
Returns
<see ( ( *( SUPERTABLE )->skipRaw )( w, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SKIPSCOPE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SKIPSCOPE( w, bp, l ) --> <see ( ( *(
SUPERTABLE )->skipScope )( w, bp, l ) )>
Argument(s)
<w>
<bp>
<l>
Returns
<see ( ( *( SUPERTABLE )->skipScope )( w, bp, l ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SORT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SORT( w, ip ) --> <see ( ( *( SUPERTABLE
)->sort )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->sort )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_STRUCTSIZE()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_STRUCTSIZE( w, sp ) --> <see ( ( *(
SUPERTABLE )->structSize )( w, sp ) )>
Argument(s)
<w>
<sp>
Returns
<see ( ( *( SUPERTABLE )->structSize )( w, sp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SYNCCHILDREN()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SYNCCHILDREN( w ) --> <see ( ( *(
SUPERTABLE )->syncChildren )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->syncChildren )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_SYSNAME()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_SYSNAME( w, bp ) --> <see ( ( *(
SUPERTABLE )->sysName )( w, bp ) )>
Argument(s)
<w>
<bp>
Returns
<see ( ( *( SUPERTABLE )->sysName )( w, bp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_TABLEEXT()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_TABLEEXT( w, fp ) --> <see ( ( *(
SUPERTABLE )->info )( w, DBI_TABLEEXT, fp ) )>
Argument(s)
<w>
<fp>
Returns
<see ( ( *( SUPERTABLE )->info )( w, DBI_TABLEEXT, fp ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_TRANS()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_TRANS( w, ip ) --> <see ( ( *( SUPERTABLE
)->trans )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->trans )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_TRANSREC()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_TRANSREC( w, ip ) --> <see ( ( *(
SUPERTABLE )->transRec )( w, ip ) )>
Argument(s)
<w>
<ip>
Returns
<see ( ( *( SUPERTABLE )->transRec )( w, ip ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_UNLOCK()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_UNLOCK( w ) --> <see ( ( *( SUPERTABLE
)->unlock )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->unlock )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_WRITEDBHEADER()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_WRITEDBHEADER( w ) --> <see ( ( *(
SUPERTABLE )->writeDBHeader )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->writeDBHeader )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
SUPER_ZAP()
Syntax
C Prototype (macro definition)
#include <hbapirdd.h> SUPER_ZAP( w ) --> <see ( ( *( SUPERTABLE
)->zap )( w ) )>
Argument(s)
<w>
Returns
<see ( ( *( SUPERTABLE )->zap )( w ) )>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Header file is hbapirdd.h
Index
C level API
hb_rddDisinherit()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddDisinherit( BYTE * drvName ) --> (
HB_ERRCODE )hResult
Argument(s)
<drvName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddExtendType()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddExtendType( USHORT fieldType ) --> (
USHORT )usResult
Argument(s)
<fieldType>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddFieldGet()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddFieldGet( HB_ITEM_PTR pItem, PHB_SYMB
pFieldSymbol ) --> ( HB_ERRCODE )hResult
Argument(s)
<pItem>
<pFieldSymbol>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddFieldPut()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddFieldPut( HB_ITEM_PTR pItem, PHB_SYMB
pFieldSymbol ) --> ( HB_ERRCODE )hResult
Argument(s)
<pItem>
<pFieldSymbol>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddFieldType()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddFieldType( USHORT extendType ) --> (
USHORT )usResult
Argument(s)
<extendType>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddGetCurrentWorkAreaNumber()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddGetCurrentWorkAreaNumber( void ) --> (
int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddGetCurrentWorkAreaPointer()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddGetCurrentWorkAreaPointer( void ) --> (
void * )pResult
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddGetFieldValue()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddGetFieldValue( HB_ITEM_PTR pItem,
PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult
Argument(s)
<pItem>
<pFieldSymbol>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddInherit()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddInherit( PRDDFUNCS pTable, PRDDFUNCS
pSubTable, PRDDFUNCS pSuperTable, BYTE * szDrvName ) --> ( HB_ERRCODE
)hResult
Argument(s)
<pTable>
<pSubTable>
<pSuperTable>
<szDrvName>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddInsertAreaNode()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddInsertAreaNode( char *szDriver ) --> (
USHORT )usResult
Argument(s)
<*szDriver>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddPutFieldValue()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddPutFieldValue( HB_ITEM_PTR pItem,
PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult
Argument(s)
<pItem>
<pFieldSymbol>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddSelectWorkAreaAlias()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddSelectWorkAreaAlias( char * szAlias ) -->
( HB_ERRCODE )hResult
Argument(s)
<szAlias>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddSelectWorkAreaNumber()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddSelectWorkAreaNumber( int iArea ) --> (
HB_ERRCODE )hResult
Argument(s)
<iArea>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddSelectWorkAreaSymbol()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddSelectWorkAreaSymbol( PHB_SYMB pSymAlias
) --> ( HB_ERRCODE )hResult
Argument(s)
<pSymAlias>
Returns
<hResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
hb_rddShutDown()
Syntax
C Prototype
#include <hbapirdd.h> hb_rddShutDown( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is rdd, nulsys, dbfntx, dbfcdx
Index
C level API
Terminal
hb_gtAdjustPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gtAdjustPos( int iHandle, char * pStr, ULONG
ulLen )
Argument(s)
<iHandle>
<pStr>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtBeginWrite()
Syntax
C Prototype
#include <hbapigt.h> hb_gtBeginWrite( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtBox()
Syntax
C Prototype
#include <hbapigt.h> hb_gtBox( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, BYTE * pbyFrame ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbyFrame>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtBoxD()
Syntax
C Prototype
#include <hbapigt.h> hb_gtBoxD( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtBoxS()
Syntax
C Prototype
#include <hbapigt.h> hb_gtBoxS( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtColorSelect()
Syntax
C Prototype
#include <hbapigt.h> hb_gtColorSelect( USHORT uiColorIndex ) --> (
USHORT )usResult
Argument(s)
<uiColorIndex>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtColorToN()
Syntax
C Prototype
#include <hbapigt.h> hb_gtColorToN( char * szColorString ) --> (
USHORT )usResult
Argument(s)
<szColorString>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtDispBegin()
Syntax
C Prototype
#include <hbapigt.h> hb_gtDispBegin( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtDispCount()
Syntax
C Prototype
#include <hbapigt.h> hb_gtDispCount( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtDispEnd()
Syntax
C Prototype
#include <hbapigt.h> hb_gtDispEnd( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtDrawShadow()
Syntax
C Prototype
#include <hbapigt.h> hb_gtDrawShadow( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, BYTE byAttr ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtEndWrite()
Syntax
C Prototype
#include <hbapigt.h> hb_gtEndWrite( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtExit()
Syntax
C Prototype
#include <hbapigt.h> hb_gtExit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtFlushCursor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtFlushCursor( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtGetBlink()
Syntax
C Prototype
#include <hbapigt.h> hb_gtGetBlink( HB_BOOL * pbBlink ) --> ( USHORT
)usResult
Argument(s)
<pbBlink>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtGetColor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtGetColor( HB_GT_RGB * color ) --> ( USHORT
)usResult
Argument(s)
<color>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtGetColorStr()
Syntax
C Prototype
#include <hbapigt.h> hb_gtGetColorStr( char * pszColorString ) --> (
USHORT )usResult
Argument(s)
<pszColorString>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtGetCursor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtGetCursor( USHORT * puiCursorShape ) --> (
USHORT )usResult
Argument(s)
<puiCursorShape>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtGetPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gtGetPos( SHORT * piRow, SHORT * piCol ) -->
( USHORT )usResult
Argument(s)
<piRow>
<piCol>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtInit()
Syntax
C Prototype
#include <hbapigt.h> hb_gtInit( int iFilenoStdin, int iFilenoStdout,
int iFilenoStderr )
Argument(s)
<iFilenoStdin>
<iFilenoStdout>
<iFilenoStderr>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtIsColor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtIsColor( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtMaxCol()
Syntax
C Prototype
#include <hbapigt.h> hb_gtMaxCol( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtMaxRow()
Syntax
C Prototype
#include <hbapigt.h> hb_gtMaxRow( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtModalRead()
Syntax
C Prototype
#include <hbapigt.h> hb_gtModalRead( void * ) --> ( USHORT )usResult
Argument(s)
<void *>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtPostExt()
Syntax
C Prototype
#include <hbapigt.h> hb_gtPostExt( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtPreExt()
Syntax
C Prototype
#include <hbapigt.h> hb_gtPreExt( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtReadKey()
Syntax
C Prototype
#include <hbapigt.h> hb_gtReadKey( HB_inkey_enum eventmask ) --> (
int )iResult
Argument(s)
<eventmask>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtRectSize()
Syntax
C Prototype
#include <hbapigt.h> hb_gtRectSize( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, USHORT * puiBuffSize ) --> ( USHORT
)usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<puiBuffSize>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtRepChar()
Syntax
C Prototype
#include <hbapigt.h> hb_gtRepChar( USHORT uiRow, USHORT uiCol, BYTE
byChar, USHORT uiCount ) --> ( USHORT )usResult
Argument(s)
<uiRow>
<uiCol>
<byChar>
<uiCount>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtRest()
Syntax
C Prototype
#include <hbapigt.h> hb_gtRest( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pScrBuff>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtResume()
Resume the terminal after the shell output
Syntax
C Prototype
#include <hbapigt.h> hb_gtResume( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSLR()
System Level Request
Syntax
C Prototype
#include <hbapigt.h> hb_gtSLR( HB_GT_SLR * pSLR ) --> ( USHORT
)usResult
Argument(s)
<pSLR>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSave()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSave( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pScrBuff>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtScrDim()
Syntax
C Prototype
#include <hbapigt.h> hb_gtScrDim( USHORT * puiHeight, USHORT *
puiWidth ) --> ( USHORT )usResult
Argument(s)
<puiHeight>
<puiWidth>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtScroll()
Syntax
C Prototype
#include <hbapigt.h> hb_gtScroll( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, SHORT iRows, SHORT iCols ) --> ( USHORT
)usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<iRows>
<iCols>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetBlink()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetBlink( HB_BOOL bBlink ) --> ( USHORT
)usResult
Argument(s)
<bBlink>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetBorder()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetBorder( HB_GT_RGB * color ) --> ( USHORT
)usResult
Argument(s)
<color>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetColor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetColor( HB_GT_RGB * color ) --> ( USHORT
)usResult
Argument(s)
<color>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetColorStr()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetColorStr( char * pszColorString ) --> (
USHORT )usResult
Argument(s)
<pszColorString>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetCursor()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetCursor( USHORT uiCursorShape ) --> (
USHORT )usResult
Argument(s)
<uiCursorShape>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetMode()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetMode( USHORT uiRows, USHORT uiCols ) -->
( USHORT )usResult
Argument(s)
<uiRows>
<uiCols>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetPos( SHORT iRow, SHORT iCol ) --> (
USHORT )usResult
Argument(s)
<iRow>
<iCol>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetPosContext()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetPosContext( SHORT iRow, SHORT iCol,
SHORT iMode ) --> ( USHORT )usResult
Argument(s)
<iRow>
<iCol>
<iMode>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSetSnowFlag()
Syntax
C Prototype
#include <hbapigt.h> hb_gtSetSnowFlag( HB_BOOL bNoSnow ) --> ( USHORT
)usResult
Argument(s)
<bNoSnow>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtSuspend()
Prepare the reminal for shell output
Syntax
C Prototype
#include <hbapigt.h> hb_gtSuspend( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtTone()
Syntax
C Prototype
#include <hbapigt.h> hb_gtTone( double dFrequency, double dDuration )
Argument(s)
<dFrequency>
<dDuration>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtVersion()
Syntax
C Prototype
#include <hbapigt.h> hb_gtVersion( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWApp()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWApp( HB_GT_WND ** wnd )
Argument(s)
<wnd>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWCreate()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWCreate( HB_GT_RECT * rect, HB_GT_WND **
wnd )
Argument(s)
<rect>
<wnd>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWCurrent()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWCurrent( HB_GT_WND * wnd )
Argument(s)
<wnd>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWDestroy()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWDestroy( HB_GT_WND * wnd )
Argument(s)
<wnd>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWFlash()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWFlash( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWPos( HB_GT_WND * wnd, HB_GT_RECT * rect )
Argument(s)
<wnd>
<rect>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWVis()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWVis( HB_GT_WND * wnd, USHORT uiStatus )
--> ( HB_BOOL )bResult
Argument(s)
<wnd>
<uiStatus>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWrite()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWrite( BYTE * pbyStr, ULONG ulLen ) --> (
USHORT )usResult
Argument(s)
<pbyStr>
<ulLen>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWriteAt()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWriteAt( USHORT uiRow, USHORT uiCol, BYTE *
pbyStr, ULONG ulLen ) --> ( USHORT )usResult
Argument(s)
<uiRow>
<uiCol>
<pbyStr>
<ulLen>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gtWriteCon()
Syntax
C Prototype
#include <hbapigt.h> hb_gtWriteCon( BYTE * pbyStr, ULONG ulLen ) -->
( USHORT )usResult
Argument(s)
<pbyStr>
<ulLen>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_AdjustPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_AdjustPos( BYTE * pStr, ULONG ulLen ) -->
( HB_BOOL )bResult
Argument(s)
<pStr>
<ulLen>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Box()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Box( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT
)usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbyFrame>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_BoxD()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_BoxD( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT
)usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbyFrame>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_BoxS()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_BoxS( USHORT uiTop, USHORT uiLeft, USHORT
uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT
)usResult
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbyFrame>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Col()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Col( void ) --> ( SHORT )sResult
Returns
<sResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_DispBegin()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_DispBegin( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_DispCount()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_DispCount( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_DispEnd()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_DispEnd( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Exit()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Exit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_GetBlink()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_GetBlink( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_GetCursorStyle()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_GetCursorStyle( void ) --> ( USHORT
)usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_GetScreenHeight()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_GetScreenHeight( void ) --> ( USHORT
)usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_GetScreenWidth()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_GetScreenWidth( void ) --> ( USHORT
)usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_GetText()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_GetText( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, BYTE * pbyDst )
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbyDst>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_HorizLine()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_HorizLine( USHORT uiRow, USHORT uiLeft,
USHORT uiRight, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult
Argument(s)
<uiRow>
<uiLeft>
<uiRight>
<byChar>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Init()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Init( int iFilenoStdin, int iFilenoStdout,
int iFilenoStderr )
Argument(s)
<iFilenoStdin>
<iFilenoStdout>
<iFilenoStderr>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_IsColor()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_IsColor( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_PostExt()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_PostExt( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_PreExt()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_PreExt( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_PutText()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_PutText( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, BYTE * pbySrc )
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<pbySrc>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Puts()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Puts( USHORT uiRow, USHORT uiCol, BYTE
byAttr, BYTE * pbyStr, ULONG ulLen )
Argument(s)
<uiRow>
<uiCol>
<byAttr>
<pbyStr>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_ReadKey()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_ReadKey( HB_inkey_enum eventmask ) --> (
int )iResult
Argument(s)
<eventmask>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_RectSize()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_RectSize( USHORT rows, USHORT cols ) --> (
int )iResult
Argument(s)
<rows>
<cols>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Replicate()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Replicate( USHORT uiTop, USHORT uiLeft,
BYTE byAttr, BYTE byChar, ULONG ulLen )
Argument(s)
<uiTop>
<uiLeft>
<byAttr>
<byChar>
<ulLen>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Resume()
Resume the terminal after the shell call
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Resume( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Row()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Row( void ) --> ( SHORT )sResult
Returns
<sResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Scroll()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Scroll( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, BYTE byAttr, SHORT iRows, SHORT
iCols )
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<byAttr>
<iRows>
<iCols>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_SetAttribute()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_SetAttribute( USHORT uiTop, USHORT uiLeft,
USHORT uiBottom, USHORT uiRight, BYTE byAttr )
Argument(s)
<uiTop>
<uiLeft>
<uiBottom>
<uiRight>
<byAttr>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_SetBlink()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_SetBlink( HB_BOOL bBlink )
Argument(s)
<bBlink>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_SetCursorStyle()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_SetCursorStyle( USHORT uiCursorShape )
Argument(s)
<uiCursorShape>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_SetMode()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_SetMode( USHORT uiRows, USHORT uiCols )
--> ( HB_BOOL )bResult
Argument(s)
<uiRows>
<uiCols>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_SetPos()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_SetPos( SHORT iRow, SHORT iCol, SHORT
iMethod )
Argument(s)
<iRow>
<iCol>
<iMethod>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Suspend()
Suspend the terminal before the shell call
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Suspend( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Tone()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Tone( double dFrequency, double dDuration )
Argument(s)
<dFrequency>
<dDuration>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_Version()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_Version( void ) --> ( char * )pszResult
Returns
<pszResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_gt_VertLine()
Syntax
C Prototype
#include <hbapigt.h> hb_gt_VertLine( USHORT uiCol, USHORT uiTop,
USHORT uiBottom, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult
Argument(s)
<uiCol>
<uiTop>
<uiBottom>
<byChar>
<byAttr>
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkey()
Wait for keyboard input
Syntax
C Prototype
#include <hbapigt.h> hb_inkey( HB_BOOL bWait, double dSeconds,
HB_inkey_enum event_mask ) --> ( int )iResult
Argument(s)
<bWait>
<dSeconds>
<event_mask>
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyGet()
Extract the next key from the Harbour keyboard buffer
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyGet( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyLast()
Return the value of the last key that was extracted
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyLast( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyNext()
Return the next key without extracting it
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyNext( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyPoll()
Poll the console keyboard to stuff the Harbour buffer
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyPoll( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyPut()
Inserts an inkey code into the keyboard buffer
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyPut( int ch )
Argument(s)
<ch>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_inkeyReset()
Reset the Harbour keyboard buffer
Syntax
C Prototype
#include <hbapigt.h> hb_inkeyReset( HB_BOOL allocate )
Argument(s)
<allocate>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseCol()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseCol( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseCountButton()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseCountButton( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseGetBounds()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseGetBounds( int * piTop, int * piLeft,
int * piBottom, int * piRight )
Argument(s)
<piTop>
<piLeft>
<piBottom>
<piRight>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseGetCursor()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseGetCursor( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseIsButtonPressed()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseIsButtonPressed( int iButton ) --> (
HB_BOOL )bResult
Argument(s)
<iButton>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseIsPresent()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseIsPresent( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseRow()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseRow( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseSetBounds()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseSetBounds( int iTop, int iLeft, int
iBottom, int iRight )
Argument(s)
<iTop>
<iLeft>
<iBottom>
<iRight>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseSetCursor()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseSetCursor( HB_BOOL bVisible )
Argument(s)
<bVisible>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouseSetPos()
Syntax
C Prototype
#include <hbapigt.h> hb_mouseSetPos( int iRow, int iCol )
Argument(s)
<iRow>
<iCol>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Col()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Col( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_CountButton()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_CountButton( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Exit()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Exit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_GetBounds()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_GetBounds( int * piTop, int * piLeft,
int * piBottom, int * piRight )
Argument(s)
<piTop>
<piLeft>
<piBottom>
<piRight>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Hide()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Hide( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Init()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Init( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_IsButtonPressed()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_IsButtonPressed( int iButton ) --> (
HB_BOOL )bResult
Argument(s)
<iButton>
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_IsPresent()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_IsPresent( void ) --> ( HB_BOOL )bResult
Returns
<bResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Row()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Row( void ) --> ( int )iResult
Returns
<iResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_SetBounds()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_SetBounds( int iTop, int iLeft, int
iBottom, int iRight )
Argument(s)
<iTop>
<iLeft>
<iBottom>
<iRight>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_SetPos()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_SetPos( int iRow, int iCol )
Argument(s)
<iRow>
<iCol>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_mouse_Show()
Syntax
C Prototype
#include <hbapigt.h> hb_mouse_Show( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_setkeyExit()
Syntax
C Prototype
#include <hbapigt.h> hb_setkeyExit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
hb_setkeyInit()
Syntax
C Prototype
#include <hbapigt.h> hb_setkeyInit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is gt* (ie. gtdos)
Index
C level API
Virtual machine
hb_stackDispCall()
Syntax
C Prototype
#include <hbvm.h> hb_stackDispCall( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_stackPop()
Pops an item from the stack
Syntax
C Prototype
#include <hbvm.h> hb_stackPop( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmDo()
Invoke the virtual machine
Syntax
C Prototype
#include <hbvm.h> hb_vmDo( USHORT uiParams )
Argument(s)
<uiParams>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmEvalBlock()
Executes passed codeblock with no arguments
Syntax
C Prototype
#include <hbvm.h> hb_vmEvalBlock( PHB_ITEM pBlockItem ) --> (
PHB_ITEM )pResult
Argument(s)
<pBlockItem>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmEvalBlockV()
Syntax
C Prototype
#include <hbvm.h> hb_vmEvalBlockV( PHB_ITEM pBlockItem, USHORT
uiArgCount, ... ) --> ( PHB_ITEM )pResult
Argument(s)
<pBlockItem>
<uiArgCount>
<...>
Returns
<pResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmExecute()
Invokes the virtual machine
Syntax
C Prototype
#include <hbvm.h> hb_vmExecute( const BYTE * pCode, PHB_SYMB pSymbols
)
Argument(s)
<pCode>
<pSymbols>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmFunction()
Executes a function saving its result
Syntax
C Prototype
#include <hbvm.h> hb_vmFunction( USHORT uiParams )
Argument(s)
<uiParams>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmInit()
Syntax
C Prototype
#include <hbvm.h> hb_vmInit( HB_BOOL bStartMainProc )
Argument(s)
<bStartMainProc>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmMessage()
Sends a message to an object
Syntax
C Prototype
#include <hbvm.h> hb_vmMessage( PHB_SYMB pSymMsg )
Argument(s)
<pSymMsg>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmProcessSymbols()
Statics symbols initialization
Syntax
C Prototype
#include <hbvm.h> hb_vmProcessSymbols( PHB_SYMB pSymbols, USHORT
uiSymbols )
Argument(s)
<pSymbols>
<uiSymbols>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPush()
Pushes a generic item onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPush( PHB_ITEM pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushDate()
Pushes a long date onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushDate( long lDate )
Argument(s)
<lDate>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushDouble()
Pushes a double number onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushDouble( double lNumber, int iDec )
Argument(s)
<lNumber>
<iDec>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushInteger()
Pushes a integer number onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushInteger( int iNumber )
Argument(s)
<iNumber>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushLogical()
Pushes a logical value onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushLogical( HB_BOOL bValue )
Argument(s)
<bValue>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushLong()
Pushes a long number onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushLong( long lNumber )
Argument(s)
<lNumber>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushNil()
In this case it places nil at self
Syntax
C Prototype
#include <hbvm.h> hb_vmPushNil( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushNumber()
Pushes a number on to the stack and decides if it is integer, long or
double
Syntax
C Prototype
#include <hbvm.h> hb_vmPushNumber( double dNumber, int iDec )
Argument(s)
<dNumber>
<iDec>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushPointer()
Push an item of HB_IT_POINTER type
Syntax
C Prototype
#include <hbvm.h> hb_vmPushPointer( void * )
Argument(s)
<void *>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushString()
Pushes a string on to the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushString( char * szText, ULONG length )
Argument(s)
<szText>
<length>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmPushSymbol()
Pushes a function pointer onto the stack
Syntax
C Prototype
#include <hbvm.h> hb_vmPushSymbol( PHB_SYMB pSym )
Argument(s)
<pSym>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmQuit()
Immediately quits the virtual machine
Syntax
C Prototype
#include <hbvm.h> hb_vmQuit( void ) --> int
Returns
ERRORLEVEL code
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmRequestBreak()
Syntax
C Prototype
#include <hbvm.h> hb_vmRequestBreak( PHB_ITEM pItem )
Argument(s)
<pItem>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmRequestCancel()
Syntax
C Prototype
#include <hbvm.h> hb_vmRequestCancel( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmRequestEndProc()
Syntax
C Prototype
#include <hbvm.h> hb_vmRequestEndProc( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmRequestQuery()
Syntax
C Prototype
#include <hbvm.h> hb_vmRequestQuery( void ) --> ( USHORT )usResult
Returns
<usResult>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmRequestQuit()
Syntax
C Prototype
#include <hbvm.h> hb_vmRequestQuit( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmSend()
Sends a message to an object
Syntax
C Prototype
#include <hbvm.h> hb_vmSend( USHORT uiParams )
Argument(s)
<uiParams>
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API
hb_vmSymbolInit_RT()
Initialization of runtime support symbols
Syntax
C Prototype
#include <hbvm.h> hb_vmSymbolInit_RT( void )
Status
Ready
Compliance
Not applicable
Platform(s)
This is available on all platforms
File(s)
Library is vm
Index
C level API