From 706918a336a66250157e24a3846b257ca835239f Mon Sep 17 00:00:00 2001 From: Brian Hays Date: Tue, 23 Jan 2001 01:58:40 +0000 Subject: [PATCH] 2000-01-22 18:00 UTC-0800 Brian Hays --- harbour/ChangeLog | 40 + harbour/contrib/rdd_ads/ads1.c | 185 +- harbour/contrib/rdd_ads/adsfunc.c | 121 +- harbour/contrib/rdd_ads/doc/en/adsfuncs.txt | 10 +- harbour/doc/en/hb_api.txt | 2600 ++++++++++--------- harbour/doc/en/hb_apiit.txt | 801 +++--- harbour/include/hbapirdd.h | 4 + harbour/include/ord.ch | 5 + 8 files changed, 2003 insertions(+), 1763 deletions(-) diff --git a/harbour/ChangeLog b/harbour/ChangeLog index e83ca87b99..e71850ebe9 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -1,3 +1,43 @@ +2000-01-22 18:00 UTC-0800 Brian Hays + * contrib/rdd_ads/ads1.c + ! integrated AOF creation into dbSetFilter if SET OPTIMIZE is on. + + AdsCreateIndex(): + * fixed bug to set focus to the new order + + added USECURRENT support for subindexing. Since ADS by default does NOT + obey the scope like COMIX, I create a While expression from the index + key and scope expression (if there is one). + NOTE: + if the new tag/file already exists AND a bagname specifies a + non-structural bag, it does not subindex! + All records get added to the index. + The app needs to see if it's there already and delete it. + (Temp tags created with USECURRENT to the structural index are + always created correctly.) + + * contrib/rdd_ads/adsfunc.c + * ADSCustomizeAOF( [] [, ] ) --> nSuccess + Added support for default values (add current record to bitmap if no + parameters are passed) and for an array of record numbers to be + passed so up to 16,383 records can be set or cleared with one call to the + server. + Now returns 0 for success, otherwise the ADS error code. + + + added AdsIsIndexed() to quickly return if currently indexed vs. natural order + I hope to remove this if we agree to make it an rdd func + + * harbour/contrib/rdd_ads/doc/en/adsfuncs.txt + +ord.ch and hbapirdd.h + added constants for DBOI_OPTLEVEL return values + #define DBOI_OPTIMIZED_NONE 0 + #define DBOI_OPTIMIZED_PART 1 + #define DBOI_OPTIMIZED_FULL 2 + +hb_api.txt +hb_apiit.txt + added text for hb_param and hb_itemParam + 2001-01-22 13:15 UTC-0500 David G. Holm + doc/en/gtslang.txt + New file provided by Marek Paliwoda diff --git a/harbour/contrib/rdd_ads/ads1.c b/harbour/contrib/rdd_ads/ads1.c index 648d61eef9..3d63051475 100644 --- a/harbour/contrib/rdd_ads/ads1.c +++ b/harbour/contrib/rdd_ads/ads1.c @@ -270,17 +270,17 @@ static BOOL strcmpNoCase( char * s1, char * s2, int n ) */ #define adsBof NULL -//ERRCODE adsBof( ADSAREAP pArea, BOOL * pBof ) -//{ -// HB_TRACE(HB_TR_DEBUG, ("adsBof(%p, %p)", pArea, pBof)); +/*ERRCODE adsBof( ADSAREAP pArea, BOOL * pBof ) +{ + HB_TRACE(HB_TR_DEBUG, ("adsBof(%p, %p)", pArea, pBof)); -// if( pArea->uiParents ) -// { -// AdsAtBOF( pArea->hTable, (UNSIGNED16 *)&(pArea->fBof) ); -// *pBof = pArea->fBof; -// } -// return SUPER_BOF( (AREAP)pArea, pBof ); -//} + if( pArea->uiParents ) + { + AdsAtBOF( pArea->hTable, (UNSIGNED16 *)&(pArea->fBof) ); + *pBof = pArea->fBof; + } + return SUPER_BOF( (AREAP)pArea, pBof ); +}*/ ERRCODE adsEof( ADSAREAP pArea, BOOL * pEof ) { @@ -987,7 +987,6 @@ static ERRCODE adsCreate( ADSAREAP pArea, LPDBOPENINFO pCreateInfo) adsLockType, adsRights, hb_set.HB_SET_MBLOCKSIZE, ucfieldDefs, &hTable); - hb_xfree(ucfieldDefs); if( uRetVal != AE_SUCCESS ) { @@ -1100,14 +1099,12 @@ static ERRCODE adsOpen( ADSAREAP pArea, LPDBOPENINFO pOpenInfo ) pArea->hOrdCurrent = 0; -//HB_TRACE(HB_TR_ALWAYS, ("\n\nadsOpen(%p) pOpenInfo->abName(%s) pOpenInfo->fShared(%d) pOpenInfo->fReadonly(%d)", -// pArea, pOpenInfo->abName, (int)pOpenInfo->fShared, (int)pOpenInfo->fReadonly )); - ulRetVal = AdsOpenTable ( 0, pOpenInfo->abName, NULL, adsFileType, adsCharType, adsLockType, adsRights, ( (pOpenInfo->fShared) ? ADS_SHARED : ADS_EXCLUSIVE ) | ( (pOpenInfo->fReadonly) ? ADS_READONLY : ADS_DEFAULT ), &hTable); + if( ulRetVal != AE_SUCCESS ) { commonError( pArea, EG_OPEN, ( USHORT ) ulRetVal, ( char * ) pOpenInfo->abName ); @@ -1356,9 +1353,13 @@ static ERRCODE adsOrderListRebuild( ADSAREAP pArea ) static ERRCODE adsOrderCreate( ADSAREAP pArea, LPDBORDERCREATEINFO pOrderInfo ) { ADSHANDLE phIndex; + ADSHANDLE hTableOrIndex ; UNSIGNED32 ulRetVal; UNSIGNED32 ulOptions = ADS_DEFAULT; - PHB_ITEM pItem = pOrderInfo->abExpr; + PHB_ITEM pExprItem = pOrderInfo->abExpr; + UNSIGNED16 pus16 = 0; + UNSIGNED8 pucWhile[ (ADS_MAX_KEY_LENGTH * 2) + 3 ]; + HB_TRACE(HB_TR_DEBUG, ("adsOrderCreate(%p, %p)", pArea, pOrderInfo)); if( !pOrderInfo->abBagName || *(pOrderInfo->abBagName) == '\0' ) @@ -1369,15 +1370,56 @@ static ERRCODE adsOrderCreate( ADSAREAP pArea, LPDBORDERCREATEINFO pOrderInfo ) ulOptions = ADS_COMPOUND; } - ulRetVal = AdsCreateIndex( pArea->hTable, pOrderInfo->abBagName, - pOrderInfo->atomBagName, (UCHAR*)hb_itemGetCPtr( pItem ), - ( pArea->lpdbOrdCondInfo && pArea->lpdbOrdCondInfo->abFor )? (UCHAR*)pArea->lpdbOrdCondInfo->abFor:(UCHAR*)"", - (UCHAR*)"", ulOptions, &phIndex); + pucWhile[0] = 0; + if ( pArea->lpdbOrdCondInfo && pArea->lpdbOrdCondInfo->fUseCurrent && pArea->hOrdCurrent ) + { + UNSIGNED8 pucScope[ ADS_MAX_KEY_LENGTH+1 ]; + UNSIGNED16 pusBufLen = ADS_MAX_KEY_LENGTH; + /* + ADS subIndex does not obey scope, so create a While expression + from the index key and scope expression if there is one. + */ + ulRetVal = AdsGetScope( pArea->hOrdCurrent, ADS_BOTTOM, pucScope, &pusBufLen ); + if ( ulRetVal == AE_SUCCESS && pusBufLen) + { + /* TODO: + if tag/file exists AND a bagname specifies a non-structural bag, it does not subindex! + Have to see if it's there already and delete it! For now, warn users to delete + secondary bags before creating temp indexes with USECURRENT + */ + AdsGetKeyType(pArea->hOrdCurrent, &pus16); + strcpy(pucWhile, (UCHAR*)hb_itemGetCPtr( pExprItem ) ); + if ( pus16 == ADS_STRING ) /* add quotation marks around the key */ + { + strcat(pucWhile, "<=\""); + strcat(pucWhile, pucScope ); + strcat(pucWhile, "\"" ); + } + else + { + strcat(pucWhile, "<="); + strcat(pucWhile, pucScope ); + } + } + hTableOrIndex = pArea->hOrdCurrent; + } + else + { + hTableOrIndex = pArea->hTable; + } + + ulRetVal = AdsCreateIndex( hTableOrIndex, pOrderInfo->abBagName, + pOrderInfo->atomBagName, (UCHAR*)hb_itemGetCPtr( pExprItem ), + ( pArea->lpdbOrdCondInfo && pArea->lpdbOrdCondInfo->abFor ) ? (UCHAR*)pArea->lpdbOrdCondInfo->abFor : (UCHAR*)"", + pucWhile, ulOptions, &phIndex); + if ( ulRetVal != AE_SUCCESS ) { commonError( pArea, EG_CREATE, ( USHORT ) ulRetVal, (char*) pOrderInfo->abBagName ); return FAILURE; - } + }else + pArea->hOrdCurrent = phIndex; + return adsGoTop( pArea ); } @@ -1501,7 +1543,7 @@ static ERRCODE adsOrderInfo( ADSAREAP pArea, USHORT uiIndex, LPDBORDERINFO pOrde case DBOI_RECNO : /* TODO: OR IS THIS JUST RECNO?? */ case DBOI_KEYNORAW : if( phIndex ) - AdsGetKeyNum ( phIndex, ADS_IGNOREFILTERS, &pul32); + AdsGetKeyNum ( phIndex, ADS_RESPECTSCOPES, &pul32); else AdsGetRecordNum ( pArea->hTable, ADS_IGNOREFILTERS, &pul32); hb_itemPutNL(pOrderInfo->itmResult, pul32); @@ -1557,8 +1599,8 @@ static ERRCODE adsOrderInfo( ADSAREAP pArea, USHORT uiIndex, LPDBORDERINFO pOrde hb_itemPutNL(pOrderInfo->itmResult, pul32); break; - case DBOI_KEYCOUNTRAW : /* ignore filter or scope */ - AdsGetRecordCount( (phIndex ? phIndex : pArea->hTable), ADS_IGNOREFILTERS, &pul32); + case DBOI_KEYCOUNTRAW : /* ignore filter but RESPECT SCOPE */ + AdsGetRecordCount( (phIndex ? phIndex : pArea->hTable), ADS_RESPECTSCOPES, &pul32); hb_itemPutNL(pOrderInfo->itmResult, pul32); break; @@ -1593,18 +1635,18 @@ static ERRCODE adsOrderInfo( ADSAREAP pArea, USHORT uiIndex, LPDBORDERINFO pOrde AdsGetAOFOptLevel( pArea->hTable, &pus16, NULL, NULL ); switch( pus16 ) { - case ADS_OPTIMIZED_FULL: - hb_itemPutNI(pOrderInfo->itmResult, 2); + case ADS_OPTIMIZED_FULL: /* ADS values are different from Harbour */ + hb_itemPutNI(pOrderInfo->itmResult, DBOI_OPTIMIZED_FULL); break; case ADS_OPTIMIZED_PART: - hb_itemPutNI(pOrderInfo->itmResult, 1); + hb_itemPutNI(pOrderInfo->itmResult, DBOI_OPTIMIZED_PART); break; default: - hb_itemPutNI(pOrderInfo->itmResult, 0); + hb_itemPutNI(pOrderInfo->itmResult, DBOI_OPTIMIZED_NONE); } break; -/* Unsupported: +/* Unsupported TODO: DBOI_FILEHANDLE DBOI_FULLPATH @@ -1616,6 +1658,7 @@ DBOI_KEYADD DBOI_KEYDELETE DBOI_KEYSINCLUDED DBOI_SKIPUNIQUE + // these are really global settings: DBOI_STRICTREAD DBOI_OPTIMIZE DBOI_AUTOORDER @@ -1639,9 +1682,20 @@ DBOI_AUTOSHARE static ERRCODE adsClearFilter( ADSAREAP pArea ) { - HB_TRACE(HB_TR_DEBUG, ("adsClearFilter(%p)", pArea)); + HB_TRACE(HB_TR_DEBUG, ("adsClearFilter(%p)", pArea)); + /* + We don't know if an AOF was used. + Since a call to the server would need to be made to see if there's an AOF + anyway, just always attempt to clear it. + /// + ///UNSIGNED8 aucAOF[64]; + ///UNSIGNED16 usLength; + /// if ( AdsGetAOF( pArea->hTable, aucAOF, &usLength ) == AE_SUCCESS && usLength > 0) + */ + AdsClearAOF ( pArea->hTable ); AdsClearFilter ( pArea->hTable ); + return SUPER_CLEARFILTER( ( AREAP ) pArea ); } @@ -1671,6 +1725,9 @@ static ERRCODE adsScopeInfo( ADSAREAP pArea, USHORT nScope, PHB_ITEM pItem ) static ERRCODE adsSetFilter( ADSAREAP pArea, LPDBFILTERINFO pFilterInfo ) { BOOL bValidExpr = FALSE; + UNSIGNED16 usResolve = ADS_RESOLVE_DYNAMIC ; /*ADS_RESOLVE_IMMEDIATE ;get this from a SETting*/ + UNSIGNED32 ulRetVal = AE_INVALID_EXPRESSION; + HB_TRACE(HB_TR_DEBUG, ("adsSetFilter(%p, %p)", pArea, pFilterInfo)); /* ----------------- NOTE: ------------------ @@ -1679,11 +1736,21 @@ static ERRCODE adsSetFilter( ADSAREAP pArea, LPDBFILTERINFO pFilterInfo ) filter the records locally. --------------------------------------------------*/ - AdsIsExprValid( pArea->hTable, (UNSIGNED8*) hb_itemGetCPtr( pFilterInfo->abFilterText), (UNSIGNED16*) &bValidExpr ); - if ( bValidExpr ) - AdsSetFilter( pArea->hTable, (UNSIGNED8*) hb_itemGetCPtr( pFilterInfo->abFilterText ) ); + /* must do this first as it calls clearFilter */ + if (SUPER_SETFILTER( ( AREAP ) pArea, pFilterInfo ) == SUCCESS ) + { + AdsIsExprValid( pArea->hTable, (UNSIGNED8*) hb_itemGetCPtr( pFilterInfo->abFilterText), (UNSIGNED16*) &bValidExpr ); + if ( bValidExpr ) + { - return SUPER_SETFILTER( ( AREAP ) pArea, pFilterInfo ); + if ( hb_set.HB_SET_OPTIMIZE ) + { + ulRetVal = AdsSetAOF( pArea->hTable, (UNSIGNED8*) hb_itemGetCPtr( pFilterInfo->abFilterText), usResolve ); + }else + ulRetVal = AdsSetFilter( pArea->hTable, (UNSIGNED8*) hb_itemGetCPtr( pFilterInfo->abFilterText ) ); + } + } + return ulRetVal == AE_SUCCESS ? SUCCESS : FAILURE ; } #define adsSetLocate NULL @@ -1917,3 +1984,55 @@ HB_FUNC( ADS_GETFUNCTABLE ) else hb_retni( FAILURE ); } + +HB_FUNC( ADSCUSTOMIZEAOF ) +{ + ADSAREAP pArea; + UNSIGNED32 ulNumRecs = 0; + UNSIGNED32 ulRecord; + UNSIGNED32 *pulRecords; + UNSIGNED16 usOption = ADS_AOF_ADD_RECORD; + UNSIGNED32 ulRetVal = AE_SUCCESS + 1; /* initialize to something other than success */ + + pArea = (ADSAREAP) hb_rddGetCurrentWorkAreaPointer(); + if( pArea ) + { + if( ISNUM(2) ) /* add, delete or toggle */ + usOption = hb_parni( 2 ); + + if( ISNIL(1) ) /* default to current record */ + { + ulNumRecs = 1; + AdsGetRecordNum( pArea->hTable, ADS_IGNOREFILTERS, + (UNSIGNED32 *)&(pArea->ulRecNo) ); + ulRecord = pArea->ulRecNo; + } + else if( ISNUM( 1 ) ) /* Passed a single recno */ + ulRecord = hb_parnl( 1 ); + else if( ISARRAY( 1 ) ) /* convert array of recnos to C array */ + ulNumRecs = hb_parinfa( 1, 0 ); + + if ( ulNumRecs ) + { + pulRecords = (UNSIGNED32 *) hb_xgrab( ulNumRecs * sizeof( UNSIGNED32 ) ); + if ( ulNumRecs > 1 ) /* convert array of recnos to C array */ + { + for ( ulRecord = 0; ulRecord < ulNumRecs; ulRecord++) + pulRecords[ulRecord] = hb_parnl( 1, ulRecord + 1); + }else + pulRecords[0] = ulRecord; + + ulRetVal = AdsCustomizeAOF( pArea->hTable, ulNumRecs, pulRecords, usOption); + /* if server has Customized AOF, clear the super filter so bits won't get flipped off! */ + if ( ulRetVal == AE_SUCCESS ) + SUPER_CLEARFILTER( ( AREAP ) pArea ); + + hb_xfree(pulRecords); + } + + hb_retnl( ulRetVal ); + } + else + hb_errRT_DBCMD( EG_NOTABLE, 2001, NULL, "ADSCUSTOMIZEAOF" ); +} + diff --git a/harbour/contrib/rdd_ads/adsfunc.c b/harbour/contrib/rdd_ads/adsfunc.c index 8d5af138a4..8dad3cdf4a 100644 --- a/harbour/contrib/rdd_ads/adsfunc.c +++ b/harbour/contrib/rdd_ads/adsfunc.c @@ -36,8 +36,9 @@ #define HB_OS_WIN_32_USED #include "hbapi.h" -#include "hbinit.h" #include "hbapiitm.h" +#include "hbinit.h" +#include "hbvm.h" #include "rddsys.ch" #include "hbapilng.h" #include "hbdate.h" @@ -53,6 +54,8 @@ int adsRights = 1; int adsCharType = ADS_ANSI; ADSHANDLE adsConnectHandle = 0; +PHB_ITEM itmCobCallBack = 0; + HB_FUNC( ADSSETFILETYPE ) { int fileType, oldType = adsFileType; @@ -273,28 +276,6 @@ HB_FUNC( ADSCLEARAOF ) hb_errRT_DBCMD( EG_NOTABLE, 2001, NULL, "ADSCLEARAOF" ); } -HB_FUNC( ADSCUSTOMIZEAOF ) -{ - ADSAREAP pArea; - UNSIGNED32 pulRecords[1]; - UNSIGNED16 usOption = ADS_AOF_ADD_RECORD; - UNSIGNED32 ulRetVal; - - pArea = (ADSAREAP) hb_rddGetCurrentWorkAreaPointer(); - if( pArea ) - { - pulRecords[0] = hb_parnl( 1 ); - if( ISNUM(2) ) - usOption = hb_parni( 2 ); - ulRetVal = AdsCustomizeAOF( pArea->hTable, 1, pulRecords, usOption); - if ( ulRetVal == AE_SUCCESS ) - hb_retl( 1 ); - else - hb_retl( 0 ); - } - else - hb_errRT_DBCMD( EG_NOTABLE, 2001, NULL, "ADSCUSTOMIZEAOF" ); -} HB_FUNC( ADSEVALAOF ) { @@ -320,17 +301,18 @@ HB_FUNC( ADSGETAOF ) ADSAREAP pArea; UNSIGNED8 pucFilter[HARBOUR_MAX_RDD_FILTER_LENGTH+1]; UNSIGNED16 pusLen = HARBOUR_MAX_RDD_FILTER_LENGTH; - UNSIGNED32 ulRetVal; + UNSIGNED32 ulRetVal = FAILURE; pArea = (ADSAREAP) hb_rddGetCurrentWorkAreaPointer(); if( pArea ) - { ulRetVal = AdsGetAOF( pArea->hTable, pucFilter, &pusLen ); - if ( ulRetVal == AE_SUCCESS ) - hb_retc( ( char * ) pucFilter ); - } else hb_errRT_DBCMD( EG_NOTABLE, 2001, NULL, "ADSGETAOF" ); + + if ( ulRetVal == AE_SUCCESS ) + hb_retc( ( char * ) pucFilter ); + else + hb_retc( "" ); } HB_FUNC( ADSGETAOFOPTLEVEL ) @@ -370,7 +352,7 @@ HB_FUNC( ADSGETAOFNOOPT ) HB_FUNC( ADSISRECORDINAOF ) { ADSAREAP pArea; - UNSIGNED32 ulRecordNumber = 0; + UNSIGNED32 ulRecordNumber = 0; /* 0 for current record */ UNSIGNED16 bIsInAOF; UNSIGNED32 ulRetVal; @@ -378,8 +360,9 @@ HB_FUNC( ADSISRECORDINAOF ) if( pArea ) { if( hb_pcount() > 0 ) - ulRecordNumber = hb_parni( 1 ); + ulRecordNumber = hb_parnl( 1 ); ulRetVal = AdsIsRecordInAOF( pArea->hTable, ulRecordNumber, &bIsInAOF ); + if ( ulRetVal == AE_SUCCESS && bIsInAOF ) hb_retl( 1 ); else @@ -404,7 +387,7 @@ HB_FUNC( ADSSETAOF ) { ADSAREAP pArea; char * pucFilter; - UNSIGNED16 usResolve = ADS_RESOLVE_IMMEDIATE; + UNSIGNED16 usResolve = ADS_RESOLVE_DYNAMIC ; //ADS_RESOLVE_IMMEDIATE UNSIGNED32 ulRetVal; pArea = (ADSAREAP) hb_rddGetCurrentWorkAreaPointer(); @@ -805,3 +788,79 @@ HB_FUNC( ADSCONVERTTABLE ) hb_errRT_DBCMD( EG_NOTABLE, 2001, NULL, " ADSCONVERTTABLE" ); } + +UNSIGNED32 WINAPI ShowPercentage( UNSIGNED16 usPercentDone ) +{ + PHB_ITEM pPercentDone = hb_itemPutNI(NULL, usPercentDone); + + if ( itmCobCallBack ) + { + hb_vmEvalBlockV( itmCobCallBack, 1, pPercentDone ) ; + } + else + { + HB_TRACE(HB_TR_DEBUG, ("ShowPercentage(%d) called with no codeblock set.\n", usPercentDone )); + } + hb_itemRelease( pPercentDone ); + return 0; + +} /* ShowPercentage */ + + +HB_FUNC( ADSREGCALLBACK ) +{ + UNSIGNED32 ulRetVal; + + /* Note: current implementation is not thread safe. + ADS can register multiple callbacks, but one per thread/connection. + To be thread safe, we need multiple connections. + The registered function (and its codeblock itmCobCallBack) should + NOT make any Advantage Client Engine calls. If it does, + it is possible to get error code 6619 "Communication Layer is busy". + + */ + + itmCobCallBack = hb_itemParam( 1 ); + if ( !itmCobCallBack || ( hb_itemType(itmCobCallBack) != HB_IT_BLOCK ) ) + { + hb_retl( FALSE ); + return; + } + hb_gcLockItem( itmCobCallBack ); + + ulRetVal = AdsRegisterProgressCallback( ShowPercentage ); + if ( ulRetVal != AE_SUCCESS ) + { + hb_gcUnlockItem( itmCobCallBack ); + hb_itemRelease( itmCobCallBack ); + itmCobCallBack = 0; + hb_retl( FALSE ); + return; + } + +} + + +HB_FUNC( ADSCLRCALLBACK ) +{ + if ( itmCobCallBack ) + { + hb_retni( AdsClearProgressCallback () ); + + hb_gcUnlockItem( itmCobCallBack ); + hb_itemRelease( itmCobCallBack ); + itmCobCallBack = 0; + + } +} + +HB_FUNC( ADSISINDEXED ) +{ + ADSAREAP pArea; + pArea = (ADSAREAP) hb_rddGetCurrentWorkAreaPointer(); + if(pArea) + hb_retl(pArea->hOrdCurrent); + else + hb_retl( FALSE ); +} + diff --git a/harbour/contrib/rdd_ads/doc/en/adsfuncs.txt b/harbour/contrib/rdd_ads/doc/en/adsfuncs.txt index 4d1e307284..fc2623396e 100644 --- a/harbour/contrib/rdd_ads/doc/en/adsfuncs.txt +++ b/harbour/contrib/rdd_ads/doc/en/adsfuncs.txt @@ -131,13 +131,13 @@ * $ONELINER$ * Add or remove records from an existing AOF * $SYNTAX$ - * ADSCustomizeAOF( [] [, ] ) --> lSuccess + * ADSCustomizeAOF( [] [, ] ) --> nSuccess * $ARGUMENTS$ * Can be either a single record number or an array of * record numbers to add or delete from the AOF. If omitted, defaults to * the current record. * - * The type of operation: + * The type of operation: * * ADS_AOF_ADD_RECORD Add the record to the AOF (set the bit). This is the default operation. @@ -145,7 +145,7 @@ * ADS_AOF_TOGGLE_RECORD Switch the record into or out of the AOF. *
* $RETURNS$ - * True if the operation is successful. + * ADS error code, or 0 for success. * $DESCRIPTION$ * An Advantage Optimized Filter (AOF) consists of a bitmap of the records in * the database. If bit 5 is on, record 5 is considered a visible record. @@ -207,6 +207,8 @@ * * Values are defined in ads.ch: * ADS_OPTIMIZED_FULL, ADS_OPTIMIZED_PART, ADS_OPTIMIZED_NONE. + * IMPORTANT NOTE: These values are NOT the same as those returned + * by dbOrderInfo(). * $DESCRIPTION$ * See ACE.HLP for full details about the Advantage Database Server. * $EXAMPLES$ @@ -268,7 +270,7 @@ * $SYNTAX$ * ADSGetAOF() --> cFilter * $ARGUMENTS$ - * None + * None * $RETURNS$ * The filter expression used in the call to AdsSetAOF. * $DESCRIPTION$ diff --git a/harbour/doc/en/hb_api.txt b/harbour/doc/en/hb_api.txt index e85faf1d48..d523c8f837 100644 --- a/harbour/doc/en/hb_api.txt +++ b/harbour/doc/en/hb_api.txt @@ -22,19 +22,19 @@ * Retrieve a string parameter * $SYNTAX$ * C Prototype - * + * * #include * hb_parc( int iParam, ... ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -44,7 +44,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -57,19 +57,19 @@ * Retrieve a string parameter length * $SYNTAX$ * C Prototype - * + * * #include * hb_parclen( int iParam, ... ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -79,7 +79,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -92,19 +92,19 @@ * Retrieve a by-reference string parameter length, including terminator * $SYNTAX$ * C Prototype - * + * * #include * hb_parcsiz( int iParam, ... ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -114,7 +114,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -127,19 +127,19 @@ * Retrieve a date as a string yyyymmdd * $SYNTAX$ * C Prototype - * + * * #include * hb_pards( int iParam, ... ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -149,7 +149,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -162,21 +162,21 @@ * Retrieve a date as a string yyyymmdd * $SYNTAX$ * C Prototype - * + * * #include * hb_pardsbuff( char * szDate, int iParam, ... ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -186,7 +186,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -199,19 +199,19 @@ * Retrieve length or element type of an array parameter * $SYNTAX$ * C Prototype - * + * * #include * hb_parinfa( int iParamNum, ULONG uiArrayIndex ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -221,7 +221,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -234,17 +234,17 @@ * Determine the param count or data type * $SYNTAX$ * C Prototype - * + * * #include * hb_parinfo( int iParam ) --> ( int )iResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -254,7 +254,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -267,19 +267,19 @@ * Retrieve a logical parameter as an int * $SYNTAX$ * C Prototype - * + * * #include * hb_parl( int iParam, ... ) --> ( int )iResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -289,7 +289,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -302,19 +302,19 @@ * Retrieve a numeric parameter as a double * $SYNTAX$ * C Prototype - * + * * #include * hb_parnd( int iParam, ... ) --> ( double )dResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -324,7 +324,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -337,19 +337,19 @@ * Retrieve a numeric parameter as a integer * $SYNTAX$ * C Prototype - * + * * #include * hb_parni( int iParam, ... ) --> ( int )iResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -359,7 +359,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -372,19 +372,19 @@ * Retrieve a numeric parameter as a long * $SYNTAX$ * C Prototype - * + * * #include * hb_parnl( int iParam, ... ) --> ( long )lResult * $ARGUMENTS$ * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -394,7 +394,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -404,22 +404,26 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * Retrieve a generic parameter + * Retrieve a direct pointer to an item parameter * $SYNTAX$ * C Prototype - * + * * #include - * hb_param( int iParam, int iMask ) --> ( PHB_ITEM )pResult + * hb_param( int iParam, int iMask ) --> ( PHB_ITEM ) pResult * $ARGUMENTS$ - * - * + * The 1-based parameter to retrieve. + * * * $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. + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -429,7 +433,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * hb_itemParam() * $END$ */ @@ -442,17 +446,17 @@ * Returns the number of suplied parameters * $SYNTAX$ * C Prototype - * + * * #include * hb_pcount( void ) --> ( int )iResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -462,7 +466,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -475,17 +479,17 @@ * Post a NIL return value * $SYNTAX$ * C Prototype - * + * * #include * hb_ret( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -495,7 +499,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -508,17 +512,17 @@ * Returns a string * $SYNTAX$ * C Prototype - * + * * #include * hb_retc( char * szText ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -528,7 +532,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -541,19 +545,19 @@ * Returns a string with a specific length * $SYNTAX$ * C Prototype - * + * * #include * hb_retclen( char * szText, ULONG ulLen ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -563,7 +567,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -576,17 +580,17 @@ * Returns a date, must use yyyymmdd format * $SYNTAX$ * C Prototype - * + * * #include * hb_retds( char * szDate ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -596,7 +600,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -609,21 +613,21 @@ * Returns a date * $SYNTAX$ * C Prototype - * + * * #include * hb_retd( long lYear, long lMonth, long lDay ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -633,7 +637,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -646,17 +650,17 @@ * Returns a long value as a julian date * $SYNTAX$ * C Prototype - * + * * #include * hb_retdl( long lJulian ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -666,7 +670,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -679,17 +683,17 @@ * Returns a logical integer * $SYNTAX$ * C Prototype - * + * * #include * hb_retl( int iTrueFalse ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -699,7 +703,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -712,17 +716,17 @@ * Returns a double * $SYNTAX$ * C Prototype - * + * * #include * hb_retnd( double dNumber ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -732,7 +736,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -745,17 +749,17 @@ * Returns a integer number * $SYNTAX$ * C Prototype - * + * * #include * hb_retni( int iNumber ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -765,7 +769,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -778,17 +782,17 @@ * Returns a long number * $SYNTAX$ * C Prototype - * + * * #include * hb_retnl( long lNumber ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -798,7 +802,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -811,21 +815,21 @@ * Returns a double, with specific width and decimals * $SYNTAX$ * C Prototype - * + * * #include * hb_retnlen( double dNumber, int iWidth, int iDec ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -835,7 +839,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -848,21 +852,21 @@ * Returns a double, with specific width and decimals * $SYNTAX$ * C Prototype - * + * * #include * hb_retndlen( double dNumber, int iWidth, int iDec ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -872,7 +876,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -885,19 +889,19 @@ * Returns a integer number, with specific width * $SYNTAX$ * C Prototype - * + * * #include * hb_retnilen( int iNumber, int iWidth ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -907,7 +911,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -920,19 +924,19 @@ * Returns a long number, with specific width * $SYNTAX$ * C Prototype - * + * * #include * hb_retnllen( long lNumber, int iWidth ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -942,7 +946,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -955,17 +959,17 @@ * Returns an array with a specific length * $SYNTAX$ * C Prototype - * + * * #include * hb_reta( ULONG ulLen ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -975,7 +979,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -988,21 +992,21 @@ * Stores a szString on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_storc( char * szText, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1012,7 +1016,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1025,23 +1029,23 @@ * Stores a fixed length string on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_storclen( char * szText, ULONG ulLength, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1051,7 +1055,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1064,21 +1068,21 @@ * SzDate must have yyyymmdd format * $SYNTAX$ * C Prototype - * + * * #include * hb_stords( char * szDate, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1088,7 +1092,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1101,21 +1105,21 @@ * Stores a logical integer on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_storl( int iLogical, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1125,7 +1129,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1138,21 +1142,21 @@ * Stores an integer on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_storni( int iValue, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1162,7 +1166,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1175,21 +1179,21 @@ * Stores a long on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_stornl( long lValue, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1199,7 +1203,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1212,21 +1216,21 @@ * Stores a double on a variable by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_stornd( double dValue, int iParam, ... ) --> void * $ARGUMENTS$ * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1236,7 +1240,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1249,17 +1253,17 @@ * Initialize fixed memory subsystem * $SYNTAX$ * C Prototype - * + * * #include * hb_xinit( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1269,7 +1273,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1282,17 +1286,17 @@ * Deinitialize fixed memory subsystem * $SYNTAX$ * C Prototype - * + * * #include * hb_xexit( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1302,7 +1306,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1315,17 +1319,17 @@ * Allocates memory, returns NULL on failure * $SYNTAX$ * C Prototype - * + * * #include * hb_xalloc( ULONG ulSize ) --> ( void * )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1335,7 +1339,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1348,17 +1352,17 @@ * Allocates memory, exits on failure * $SYNTAX$ * C Prototype - * + * * #include * hb_xgrab( ULONG ulSize ) --> ( void * )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1368,7 +1372,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1381,17 +1385,17 @@ * Frees memory * $SYNTAX$ * C Prototype - * + * * #include * hb_xfree( void * pMem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1401,7 +1405,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1414,19 +1418,19 @@ * Reallocates memory * $SYNTAX$ * C Prototype - * + * * #include * hb_xrealloc( void * pMem, ULONG ulSize ) --> ( void * )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1436,7 +1440,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1449,17 +1453,17 @@ * Returns the size of an allocated memory block * $SYNTAX$ * C Prototype - * + * * #include * hb_xsize( void * pMem ) --> ( ULONG )ulResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1469,7 +1473,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1482,17 +1486,17 @@ * Query different types of memory information * $SYNTAX$ * C Prototype - * + * * #include * hb_xquery( USHORT uiMode ) --> ( ULONG )ulResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1502,7 +1506,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1515,21 +1519,21 @@ * Copy more than memcpy() can * $SYNTAX$ * C Prototype - * + * * #include * hb_xmemcpy( void * pDestArg, void * pSourceArg, ULONG ulLen ) --> ( void * )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not UINT_MAX == ULONG_MAX * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1539,7 +1543,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1552,21 +1556,21 @@ * Set more than memset() can * $SYNTAX$ * C Prototype - * + * * #include * hb_xmemset( void * pDestArg, int iFill, ULONG ulLen ) --> ( void * )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: not UINT_MAX == ULONG_MAX * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1576,7 +1580,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1589,19 +1593,19 @@ * Creates a new array * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayNew( PHB_ITEM pItem, ULONG ulLen ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1611,7 +1615,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1624,17 +1628,17 @@ * Retrives the array len * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayLen( PHB_ITEM pArray ) --> ( ULONG )ulResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1644,7 +1648,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1657,17 +1661,17 @@ * Retrives if the array is an object * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayIsObject( PHB_ITEM pArray ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1677,7 +1681,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1690,19 +1694,19 @@ * Add a new item to the end of an array item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayAdd( PHB_ITEM pArray, PHB_ITEM pItemValue ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1712,7 +1716,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1725,19 +1729,19 @@ * Insert a nil item into an array, without changing the length * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayIns( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1747,7 +1751,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1760,19 +1764,19 @@ * Delete an array item, without changing length * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayDel( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1782,7 +1786,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1795,19 +1799,19 @@ * Sets the array total length * $SYNTAX$ * C Prototype - * + * * #include * hb_arraySize( PHB_ITEM pArray, ULONG ulLen ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1817,7 +1821,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1830,19 +1834,19 @@ * Retrieve last item in an array * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayLast( PHB_ITEM pArray, PHB_ITEM pResult ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1852,7 +1856,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1865,17 +1869,17 @@ * Releases an array - don't call it - use ItemRelease() !!! * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayRelease( PHB_ITEM pArray ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1885,7 +1889,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1898,21 +1902,21 @@ * Sets an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arraySet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1922,7 +1926,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1935,21 +1939,21 @@ * Retrieves an item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1959,7 +1963,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1972,19 +1976,19 @@ * Returns pointer to specified element of the array * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetItemPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1994,7 +1998,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2007,23 +2011,23 @@ * Copy a string into an array item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayCopyC( PHB_ITEM pArray, ULONG ulIndex, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2033,7 +2037,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2046,19 +2050,19 @@ * Retrieves the string contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetC( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2068,7 +2072,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2081,19 +2085,19 @@ * Retrieves the string pointer on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetCPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2103,7 +2107,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2116,19 +2120,19 @@ * Retrieves the string length contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetCLen( PHB_ITEM pArray, ULONG ulIndex ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2138,7 +2142,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2151,19 +2155,19 @@ * Retrieves the logical value contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetL( PHB_ITEM pArray, ULONG ulIndex ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2173,7 +2177,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2186,19 +2190,19 @@ * Retrieves the int value contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetNI( PHB_ITEM pArray, ULONG ulIndex ) --> ( int )iResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2208,7 +2212,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2221,19 +2225,19 @@ * Retrieves the long numeric value contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetNL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2243,7 +2247,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2256,19 +2260,19 @@ * Retrieves the double value contained on an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetND( PHB_ITEM pArray, ULONG ulIndex ) --> ( double )dResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2278,7 +2282,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2291,21 +2295,21 @@ * Retrieves the date value contained in an array element * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetDS( PHB_ITEM pArray, ULONG ulIndex, char * szDate ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2315,7 +2319,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2328,19 +2332,19 @@ * Retrieves the date value contained in an array element, as a long integer * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetDL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2350,7 +2354,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2363,19 +2367,19 @@ * Retrieves the type of an array item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayGetType( PHB_ITEM pArray, ULONG ulIndex ) --> ( USHORT )usResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2385,7 +2389,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2398,23 +2402,23 @@ * Fill an array with a given item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayFill( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2424,7 +2428,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2437,23 +2441,23 @@ * Scan an array for a given item, or until code-block item returns TRUE * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayScan( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2463,7 +2467,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2476,23 +2480,23 @@ * Execute a code-block for every element of an array item * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayEval( PHB_ITEM pArray, PHB_ITEM bBlock, ULONG * pulStart, ULONG * pulCount ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2502,7 +2506,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2515,25 +2519,25 @@ * Copy items from one array to another * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayCopy( PHB_ITEM pSrcArray, PHB_ITEM pDstArray, ULONG * pulStart, ULONG * pulCount, ULONG * pulTarget ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2543,7 +2547,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2556,17 +2560,17 @@ * Returns a duplicate of an existing array, including all nested items * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayClone( PHB_ITEM pArray ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2576,7 +2580,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2589,23 +2593,23 @@ * Sorts an array item * $SYNTAX$ * C Prototype - * + * * #include * hb_arraySort( PHB_ITEM pArray, ULONG * pulStart, ULONG * pulCount, PHB_ITEM pBlock ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2615,7 +2619,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2628,19 +2632,19 @@ * Compare two strings without regards to case * $SYNTAX$ * C Prototype - * + * * #include * hb_stricmp( const char * s1, const char * s2 ) --> ( int )iResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2650,7 +2654,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2663,21 +2667,21 @@ * Compare two string without regards to case, limited by length * $SYNTAX$ * C Prototype - * + * * #include * hb_strnicmp( const char * s1, const char * s2, ULONG ulLen ) --> ( int )iResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2687,7 +2691,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2700,17 +2704,17 @@ * Convert a string in-place to upper-case * $SYNTAX$ * C Prototype - * + * * #include * hb_strupr( char * pszText ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2720,7 +2724,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2733,17 +2737,17 @@ * Returns a pointer to a newly allocated copy of the source string * $SYNTAX$ * C Prototype - * + * * #include * hb_strdup( const char * pszText ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2753,7 +2757,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2766,19 +2770,19 @@ * Compare two strings using a regular expression pattern * $SYNTAX$ * C Prototype - * + * * #include * hb_strMatchRegExp( const char * szString, const char * szMask ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2788,7 +2792,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2801,19 +2805,19 @@ * Returns whether a string contains only white space * $SYNTAX$ * C Prototype - * + * * #include * hb_strEmpty( const char * szText, ULONG ulLen ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2823,7 +2827,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2836,21 +2840,21 @@ * Copy a string to a buffer, inverting each character * $SYNTAX$ * C Prototype - * + * * #include * hb_strDescend( char * szStringTo, const char * szStringFrom, ULONG ulLen ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2860,7 +2864,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2873,23 +2877,23 @@ * Returns an index to a sub-string within another string * $SYNTAX$ * C Prototype - * + * * #include * hb_strAt( const char * szSub, ULONG ulSubLen, const char * szText, ULONG ulLen ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2899,7 +2903,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2912,19 +2916,19 @@ * Convert an existing string buffer to upper case * $SYNTAX$ * C Prototype - * + * * #include * hb_strUpper( char * szText, ULONG ulLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2934,7 +2938,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2947,19 +2951,19 @@ * Convert an existing string buffer to lower case * $SYNTAX$ * C Prototype - * + * * #include * hb_strLower( char * szText, ULONG ulLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2969,7 +2973,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2982,21 +2986,21 @@ * Copy an existing string buffer to another buffer, as upper case * $SYNTAX$ * C Prototype - * + * * #include * hb_strncpyUpper( char * pDest, const char * pSource, ULONG ulLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3006,7 +3010,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3019,19 +3023,19 @@ * Return the numeric value of a character string representation of a number * $SYNTAX$ * C Prototype - * + * * #include * hb_strVal( const char * szText, ULONG ulLen ) --> ( double )dResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3041,7 +3045,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3054,19 +3058,19 @@ * Return a pointer to the first non-white space character * $SYNTAX$ * C Prototype - * + * * #include * hb_strLTrim( const char * szText, ULONG * ulLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3076,7 +3080,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3089,21 +3093,21 @@ * Return length of a string, ignoring trailing white space (or true spaces) * $SYNTAX$ * C Prototype - * + * * #include * hb_strRTrimLen( const char * szText, ULONG ulLen, BOOL bAnySpace ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3113,7 +3117,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3126,19 +3130,19 @@ * Round a number to a specific number of digits * $SYNTAX$ * C Prototype - * + * * #include * hb_numRound( double dResult, int iDec ) --> ( double )dResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3148,7 +3152,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3161,17 +3165,17 @@ * Releases all defined classes * $SYNTAX$ * C Prototype - * + * * #include * hb_clsReleaseAll( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3181,7 +3185,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3194,17 +3198,17 @@ * Retrieves an object class name * $SYNTAX$ * C Prototype - * + * * #include * hb_objGetClsName( PHB_ITEM pObject ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3214,7 +3218,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3227,19 +3231,19 @@ * Returns the method pointer of a object class * $SYNTAX$ * C Prototype - * + * * #include * hb_objGetMethod( PHB_ITEM pObject, PHB_SYMB pSymMsg ) --> ( PHB_FUNC )hResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3249,7 +3253,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3262,19 +3266,19 @@ * Returns TRUE/FALSE whether szString is an existing message for object * $SYNTAX$ * C Prototype - * + * * #include * hb_objHasMsg( PHB_ITEM pObject, char * szString ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3284,7 +3288,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3297,17 +3301,17 @@ * Finds and creates a dynamic symbol if not found * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymGet( char * szName ) --> ( PHB_DYNS )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3317,7 +3321,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3330,17 +3334,17 @@ * Creates a new dynamic symbol based on a local one * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymNew( PHB_SYMB pSymbol ) --> ( PHB_DYNS )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3350,7 +3354,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3363,17 +3367,17 @@ * Finds a dynamic symbol * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymFind( char * szName ) --> ( PHB_DYNS )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3383,7 +3387,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3396,17 +3400,17 @@ * Converts to uppercase and finds a dynamic symbol * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymFindName( char * szName ) --> ( PHB_DYNS )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3416,7 +3420,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3429,17 +3433,17 @@ * Displays all dynamic symbols * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymLog( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3449,7 +3453,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3462,17 +3466,17 @@ * Releases the memory of the dynamic symbol table * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymRelease( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3482,7 +3486,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3495,19 +3499,19 @@ * Enumerates all dynamic symbols * $SYNTAX$ * C Prototype - * + * * #include * hb_dynsymEval( PHB_DYNS_FUNC pFunction, void * Cargo ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3517,7 +3521,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3530,19 +3534,19 @@ * Initialize command line argument API's * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargInit( int argc, char * argv[] ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3552,7 +3556,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3565,17 +3569,17 @@ * Retrieve command line argument count * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargARGC( void ) --> ( int )iResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3585,7 +3589,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3598,17 +3602,17 @@ * Retrieve command line argument buffer pointer * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargARGV( void ) --> ( char ** )ppszResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3618,7 +3622,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3631,17 +3635,17 @@ * Determine if a string is an internal setting * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargIsInternal( const char * szArg ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3651,7 +3655,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3664,17 +3668,17 @@ * Check if a given internal switch (like //INFO) was set * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargCheck( const char * pszName ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3684,7 +3688,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3697,17 +3701,17 @@ * Returns the string value of an internal switch (like //TEMPPATH:"C:\") * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargString( const char * pszName ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3717,7 +3721,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3730,17 +3734,17 @@ * Returns the numeric value of an internal switch (like //F:90) * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargNum( const char * pszName ) --> ( int )iResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3750,7 +3754,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3763,17 +3767,17 @@ * Check for command line internal arguments * $SYNTAX$ * C Prototype - * + * * #include * hb_cmdargProcessVM( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3783,7 +3787,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3796,17 +3800,17 @@ * Create a new symbol * $SYNTAX$ * C Prototype - * + * * #include * hb_symbolNew( char * szName ) --> ( PHB_SYMB )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3816,7 +3820,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3829,23 +3833,23 @@ * Create a code-block * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockNew( BYTE * pBuffer, USHORT uiLocals, USHORT * pLocalPosTable, PHB_SYMB pSymbols ) --> ( HB_CODEBLOCK_PTR )hResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3855,7 +3859,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3865,22 +3869,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockMacroNew( BYTE * pBuffer, USHORT usLen ) --> ( HB_CODEBLOCK_PTR )hResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3890,7 +3894,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3903,17 +3907,17 @@ * Delete a codeblock * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockDelete( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3923,7 +3927,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3936,19 +3940,19 @@ * Get local variable referenced in a codeblock * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockGetVar( PHB_ITEM pItem, LONG iItemPos ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3958,7 +3962,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -3971,19 +3975,19 @@ * Get local variable passed by reference * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockGetRef( PHB_ITEM pItem, PHB_ITEM pRefer ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -3993,7 +3997,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4006,17 +4010,17 @@ * Evaluate a codeblock * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockEvaluate( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4026,7 +4030,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4039,19 +4043,19 @@ * Copy a codeblock * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockCopy( PHB_ITEM pDest, PHB_ITEM pSource ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4061,7 +4065,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4074,19 +4078,19 @@ * Create a new global value * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarValueNew( HB_ITEM_PTR pSource, BOOL bTrueMemvar ) --> ( HB_HANDLE )hResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4096,7 +4100,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4109,17 +4113,17 @@ * Retrieve the base address of the values table * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarValueBaseAddress( void ) --> ( HB_VALUE_PTR * )phResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4129,7 +4133,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4142,17 +4146,17 @@ * Initialize the memvar API system * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarsInit( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4162,7 +4166,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4175,17 +4179,17 @@ * Clear all PUBLIC and PRIVATE variables * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarsRelease( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4195,7 +4199,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4208,17 +4212,17 @@ * Release the memvar API system * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarsFree( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4228,7 +4232,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4241,17 +4245,17 @@ * Increase the reference count of a global value * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarValueIncRef( HB_HANDLE hValue ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4261,7 +4265,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4274,17 +4278,17 @@ * Decrease the reference count of a global value * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarValueDecRef( HB_HANDLE hValue ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4294,7 +4298,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4307,19 +4311,19 @@ * Copy an item into a symbol * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarSetValue( PHB_SYMB pMemvarSymb, HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4329,7 +4333,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4342,19 +4346,19 @@ * Copy an symbol value into an item * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarGet( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> ( ERRCODE )hResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4364,7 +4368,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4377,19 +4381,19 @@ * Copy an symbol value into an item, with error trapping * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarGetValue( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4399,7 +4403,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4412,19 +4416,19 @@ * Copy a reference to a symbol value into an item, with error trapping * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarGetRefer( HB_ITEM_PTR pItem, PHB_SYMB pMemvarSymb ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4434,7 +4438,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4447,17 +4451,17 @@ * Retrieve current PRIVATE variables stack base * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarGetPrivatesBase( void ) --> ( ULONG )ulResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4467,7 +4471,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4480,17 +4484,17 @@ * Release PRIVATE variables created after specified base * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarSetPrivatesBase( ULONG ulBase ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4500,7 +4504,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4510,22 +4514,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarNewParameter( PHB_SYMB pSymbol, PHB_ITEM pValue ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4535,7 +4539,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4545,22 +4549,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarGetStrValuePtr( char * szVarName, ULONG *pulLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * <*pulLen> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4570,7 +4574,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4580,24 +4584,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarCreateFromItem( PHB_ITEM pMemvar, BYTE bScope, PHB_ITEM pValue ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4607,7 +4611,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4620,19 +4624,19 @@ * Retrieve scope of a dynamic variable symbol * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarScope( char * szVarName, ULONG ulLength ) --> ( int )iResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4642,7 +4646,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4655,17 +4659,17 @@ * Initialize the console API system * $SYNTAX$ * C Prototype - * + * * #include * hb_conInit( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4675,7 +4679,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4688,17 +4692,17 @@ * Release the console API system * $SYNTAX$ * C Prototype - * + * * #include * hb_conRelease( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4708,7 +4712,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4721,17 +4725,17 @@ * Retrieve a pointer to a static buffer containing new-line characters * $SYNTAX$ * C Prototype - * + * * #include * hb_conNewLine( void ) --> ( char * )pszResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4741,7 +4745,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4754,19 +4758,19 @@ * Output an string to STDOUT * $SYNTAX$ * C Prototype - * + * * #include * hb_conOutStd( char * pStr, ULONG ulLen ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4776,7 +4780,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4789,19 +4793,19 @@ * Output an string to STDERR * $SYNTAX$ * C Prototype - * + * * #include * hb_conOutErr( char * pStr, ULONG ulLen ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4811,7 +4815,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4824,19 +4828,19 @@ * Retrieve and optionally set cursor shape * $SYNTAX$ * C Prototype - * + * * #include * hb_conSetCursor( BOOL bSetCursor, USHORT usNewCursor ) --> ( USHORT )usResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4846,7 +4850,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4859,17 +4863,17 @@ * Retrieve and optionally set console color * $SYNTAX$ * C Prototype - * + * * #include * hb_conSetColor( char * szColor ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4879,7 +4883,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4892,17 +4896,17 @@ * Release the save/restore API * $SYNTAX$ * C Prototype - * + * * #include * hb_conXSaveRestRelease( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4912,7 +4916,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4925,17 +4929,17 @@ * Determines if a string contains a reserve word * $SYNTAX$ * C Prototype - * + * * #include * hb_compReservedName( char * szName ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4945,7 +4949,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4958,19 +4962,19 @@ * Retrieve a procedure name into a buffer * $SYNTAX$ * C Prototype - * + * * #include * hb_procname( int iLevel, char * szName ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -4980,7 +4984,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -4993,17 +4997,17 @@ * Retrieve results of a macro expansion * $SYNTAX$ * C Prototype - * + * * #include * hb_macroGetValue( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5013,7 +5017,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5026,17 +5030,17 @@ * Assign a value to a macro-expression item * $SYNTAX$ * C Prototype - * + * * #include * hb_macroSetValue( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5046,7 +5050,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5059,17 +5063,17 @@ * Macro text substitution * $SYNTAX$ * C Prototype - * + * * #include * hb_macroTextValue( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5079,7 +5083,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5092,17 +5096,17 @@ * Handle a macro function calls, e.g. var := ¯o() * $SYNTAX$ * C Prototype - * + * * #include * hb_macroPushSymbol( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5112,7 +5116,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5125,17 +5129,17 @@ * Executes pcode compiled by macro compiler * $SYNTAX$ * C Prototype - * + * * #include * hb_macroRun( HB_MACRO_PTR pMacro ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5145,7 +5149,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5158,17 +5162,17 @@ * Compile a string and return a pcode buffer * $SYNTAX$ * C Prototype - * + * * #include * hb_macroCompile( char * szString ) --> ( HB_MACRO_PTR )hResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5178,7 +5182,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5191,17 +5195,17 @@ * Release all memory allocated for macro evaluation * $SYNTAX$ * C Prototype - * + * * #include * hb_macroDelete( HB_MACRO_PTR pMacro ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5211,7 +5215,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5224,19 +5228,19 @@ * Substitute macro variables occurences within a given string * $SYNTAX$ * C Prototype - * + * * #include * hb_macroTextSubst( char * szString, ULONG *pulStringLen ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * <*pulStringLen> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5246,7 +5250,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5259,17 +5263,17 @@ * Determine if a string is a valid function or variable name * $SYNTAX$ * C Prototype - * + * * #include * hb_macroIsIdent( char * szString ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5279,7 +5283,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5292,19 +5296,19 @@ * Compiles and evaluates an aliased macro expression * $SYNTAX$ * C Prototype - * + * * #include * hb_macroPopAliasedValue( HB_ITEM_PTR pAlias, HB_ITEM_PTR pVar ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5314,7 +5318,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5327,19 +5331,19 @@ * Compiles and evaluates an aliased macro expression * $SYNTAX$ * C Prototype - * + * * #include * hb_macroPushAliasedValue( HB_ITEM_PTR pAlias, HB_ITEM_PTR pVar ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5349,7 +5353,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5362,17 +5366,17 @@ * Determine the type of an expression * $SYNTAX$ * C Prototype - * + * * #include * hb_macroGetType( HB_ITEM_PTR pItem ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5382,7 +5386,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5395,19 +5399,19 @@ * Allocates a memory controlled by the garbage collector * $SYNTAX$ * C Prototype - * + * * #include * hb_gcAlloc( ULONG ulSize, HB_GARBAGE_FUNC_PTR pFunc ) --> ( void * )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5417,7 +5421,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5430,17 +5434,17 @@ * Deallocates a memory allocated by the garbage collector * $SYNTAX$ * C Prototype - * + * * #include * hb_gcFree( void *pAlloc ) --> void * $ARGUMENTS$ * <*pAlloc> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5450,7 +5454,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5463,17 +5467,17 @@ * Do not release passed memory block * $SYNTAX$ * C Prototype - * + * * #include * hb_gcLock( void *pAlloc ) --> ( void * )pResult * $ARGUMENTS$ * <*pAlloc> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5483,7 +5487,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5496,17 +5500,17 @@ * Passed block is allowed to be released * $SYNTAX$ * C Prototype - * + * * #include * hb_gcUnlock( void *pAlloc ) --> ( void * )pResult * $ARGUMENTS$ * <*pAlloc> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5516,7 +5520,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5529,17 +5533,17 @@ * Do not release a memory block stored inside an item * $SYNTAX$ * C Prototype - * + * * #include * hb_gcLockItem( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5549,7 +5553,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5562,17 +5566,17 @@ * Allow to release the item * $SYNTAX$ * C Prototype - * + * * #include * hb_gcUnlockItem( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5582,7 +5586,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5595,17 +5599,17 @@ * Checks if a single memory block can be released * $SYNTAX$ * C Prototype - * + * * #include * hb_gcCollect( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5615,7 +5619,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5628,17 +5632,17 @@ * Checks if all memory blocks can be released * $SYNTAX$ * C Prototype - * + * * #include * hb_gcCollectAll( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5648,7 +5652,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5661,17 +5665,17 @@ * Checks if passed item refers passed memory block pointer * $SYNTAX$ * C Prototype - * + * * #include * hb_gcItemRef( HB_ITEM_PTR pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5681,7 +5685,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5694,17 +5698,17 @@ * Hvm.c - mark all local variables as used * $SYNTAX$ * C Prototype - * + * * #include * hb_vmIsLocalRef( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5714,7 +5718,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5727,17 +5731,17 @@ * Hvm.c - mark all static variables as used * $SYNTAX$ * C Prototype - * + * * #include * hb_vmIsStaticRef( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5747,7 +5751,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5760,17 +5764,17 @@ * Memvars.c - mark all memvar variables as used * $SYNTAX$ * C Prototype - * + * * #include * hb_memvarsIsMemvarRef( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5780,7 +5784,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5793,17 +5797,17 @@ * Classes.c - mark all class internals as used * $SYNTAX$ * C Prototype - * + * * #include * hb_clsIsClassRef( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5813,7 +5817,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5826,17 +5830,17 @@ * Clear a codeblock before releasing by the GC * $SYNTAX$ * C Prototype - * + * * #include * hb_codeblockDeleteGarbage( void * Cargo ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5846,7 +5850,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5859,17 +5863,17 @@ * Clear an array before releasing by the GC * $SYNTAX$ * C Prototype - * + * * #include * hb_arrayReleaseGarbage( void * Cargo ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5879,7 +5883,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5892,17 +5896,17 @@ * Services a single idle state * $SYNTAX$ * C Prototype - * + * * #include * hb_idleState( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5912,7 +5916,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5925,17 +5929,17 @@ * Closes all background tasks * $SYNTAX$ * C Prototype - * + * * #include * hb_idleShutDown( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5945,7 +5949,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5958,17 +5962,17 @@ * Retrieves a newly allocated buffer containing platform version * $SYNTAX$ * C Prototype - * + * * #include * hb_verPlatform( void ) --> ( char * )pszResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -5978,7 +5982,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -5991,17 +5995,17 @@ * Retrieves a newly allocated buffer containing compiler version * $SYNTAX$ * C Prototype - * + * * #include * hb_verCompiler( void ) --> ( char * )pszResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6011,7 +6015,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6024,17 +6028,17 @@ * Retrieves a newly allocated buffer containing harbour version * $SYNTAX$ * C Prototype - * + * * #include * hb_verHarbour( void ) --> ( char * )pszResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6044,7 +6048,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6057,17 +6061,17 @@ * Display harbour, compiler, and platform versions to standard console * $SYNTAX$ * C Prototype - * + * * #include * hb_verBuildInfo( void ) --> void * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6077,7 +6081,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6087,22 +6091,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_OF_TYPE( p, t ) --> type & ~HB_IT_BYREF ) == t )> * $ARGUMENTS$ *

- * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6112,7 +6116,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6122,20 +6126,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_BYREF( p ) --> type & HB_IT_BYREF )> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6145,7 +6149,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6155,20 +6159,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_ARRAY( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6178,7 +6182,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6188,20 +6192,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_NIL( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6211,7 +6215,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6221,20 +6225,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_BLOCK( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6244,7 +6248,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6254,20 +6258,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_DATE( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6277,7 +6281,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6287,20 +6291,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_DOUBLE( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6310,7 +6314,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6320,20 +6324,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_INTEGER( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6343,7 +6347,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6353,20 +6357,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_LOGICAL( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6376,7 +6380,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6386,20 +6390,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_LONG( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6409,7 +6413,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6419,20 +6423,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_NUMERIC( p ) --> type & HB_IT_NUMERIC )> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6442,7 +6446,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6452,20 +6456,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_OBJECT( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6475,7 +6479,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6485,20 +6489,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_STRING( p ) --> type & ~( HB_IT_BYREF | HB_IT_MEMOFLAG ) ) == HB_IT_STRING )> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6508,7 +6512,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6518,20 +6522,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_MEMO( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6541,7 +6545,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6551,20 +6555,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_SYMBOL( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6574,7 +6578,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6584,20 +6588,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_MEMVAR( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6607,7 +6611,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6617,20 +6621,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_IS_POINTER( p ) --> * $ARGUMENTS$ *

* $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6640,7 +6644,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6653,17 +6657,17 @@ * NOTE: Intentionally using a different method * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISNIL( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6673,7 +6677,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6683,20 +6687,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISCHAR( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6706,7 +6710,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6716,20 +6720,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISNUM( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6739,7 +6743,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6749,20 +6753,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISLOG( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6772,7 +6776,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6782,20 +6786,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISDATE( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6805,7 +6809,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6815,20 +6819,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISMEMO( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6838,7 +6842,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6851,17 +6855,17 @@ * NOTE: Intentionally using a different method * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISBYREF( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6871,7 +6875,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6881,20 +6885,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISARRAY( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6904,7 +6908,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6917,17 +6921,17 @@ * Not available in CA-Cl*pper. * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISBLOCK( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6937,7 +6941,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6950,17 +6954,17 @@ * Not available in CA-Cl*pper. * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * ISPOINTER( n ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -6970,7 +6974,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -6980,20 +6984,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_pcount( ) --> item.asSymbol.paramcnt )> * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7003,7 +7007,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7013,20 +7017,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_ret( ) --> * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7036,7 +7040,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7046,20 +7050,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_reta( ulLen ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7069,7 +7073,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7079,20 +7083,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retc( szText ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7102,7 +7106,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7112,22 +7116,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retclen( szText, ulLen ) --> * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7137,7 +7141,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7147,20 +7151,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retds( szDate ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7170,7 +7174,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7180,24 +7184,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retd( lYear, lMonth, lDay ) --> * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7207,7 +7211,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7217,20 +7221,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retdl( lJulian ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7240,7 +7244,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7250,20 +7254,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retl( iLogical ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7273,7 +7277,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7283,20 +7287,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retnd( dNumber ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7306,7 +7310,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7316,20 +7320,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retni( iNumber ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7339,7 +7343,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7349,20 +7353,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retnl( lNumber ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7372,7 +7376,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7382,24 +7386,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retnlen( dNumber, iWidth, iDec ) --> * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7409,7 +7413,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7419,24 +7423,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retndlen( dNumber, iWidth, iDec ) --> * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7446,7 +7450,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7456,22 +7460,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retnilen( iNumber, iWidth ) --> * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7481,7 +7485,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7491,22 +7495,22 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * hb_retnllen( lNumber, iWidth ) --> * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: HB_API_MACROS * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7516,7 +7520,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -7526,24 +7530,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro replacement) - * + * * #include * hb_xmemcpy --> * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: UINT_MAX == ULONG_MAX * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * + * * $FILES$ * Header file is hbapi.h * $PLATFORMS$ @@ -7559,24 +7563,24 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro replacement) - * + * * #include * hb_xmemset --> * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ * Conditional on: UINT_MAX == ULONG_MAX * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * + * * $FILES$ * Header file is hbapi.h * $PLATFORMS$ @@ -7592,20 +7596,20 @@ * $CATEGORY$ * Extend API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype (macro definition) - * + * * #include * HB_ISSPACE( c ) --> * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -7615,7 +7619,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ diff --git a/harbour/doc/en/hb_apiit.txt b/harbour/doc/en/hb_apiit.txt index fe9a30479e..f3c82962a0 100644 --- a/harbour/doc/en/hb_apiit.txt +++ b/harbour/doc/en/hb_apiit.txt @@ -19,20 +19,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_evalLaunch( PEVALINFO pEvalInfo ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -42,7 +42,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -52,22 +52,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_evalNew( PEVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -77,7 +77,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -87,22 +87,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_evalPutParam( PEVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -112,7 +112,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -122,20 +122,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_evalRelease( PEVALINFO pEvalInfo ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -145,7 +145,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -155,26 +155,26 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemDo( PHB_ITEM pItem, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -184,7 +184,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -194,26 +194,26 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemDoC( char * szFunc, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * <...> * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -223,7 +223,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -233,22 +233,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemArrayGet( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -258,7 +258,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -268,20 +268,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemArrayNew( ULONG ulLen ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -291,7 +291,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -301,24 +301,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemArrayPut( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -328,7 +328,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -338,24 +338,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemCopyC( PHB_ITEM pItem, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -365,7 +365,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -375,20 +375,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemFreeC( char * szText ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -398,7 +398,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -408,20 +408,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetC( PHB_ITEM pItem ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -431,7 +431,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -441,20 +441,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetCPtr( PHB_ITEM pItem ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -464,7 +464,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -474,20 +474,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetCLen( PHB_ITEM pItem ) --> ( ULONG )ulResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -497,7 +497,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -507,22 +507,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetDS( PHB_ITEM pItem, char * szDate ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -532,7 +532,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -542,20 +542,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetDL( PHB_ITEM pItem ) --> ( long )lResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -565,7 +565,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -575,20 +575,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetL( PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -598,7 +598,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -608,20 +608,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetND( PHB_ITEM pItem ) --> ( double )dResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -631,7 +631,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -641,20 +641,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetNI( PHB_ITEM pItem ) --> ( int )iResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -664,7 +664,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -674,20 +674,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetNL( PHB_ITEM pItem ) --> ( long )lResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -697,7 +697,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -707,24 +707,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetNLen( PHB_ITEM pItem, int * piWidth, int * piDec ) --> void * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -734,7 +734,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -744,20 +744,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemGetPtr( PHB_ITEM pItem ) --> ( void * )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -767,7 +767,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -777,20 +777,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemNew( PHB_ITEM pNull ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -800,7 +800,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -810,20 +810,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemInit( PHB_ITEM pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -833,7 +833,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -843,20 +843,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPCount( void ) --> ( USHORT )usResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -866,7 +866,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -876,20 +876,27 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * Creates a copy of an item parameter (outside the eval stack) * $SYNTAX$ * C Prototype - * + * * #include * hb_itemParam( USHORT uiParam ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ - * + * 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. + * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -899,7 +906,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * hb_param() * $END$ */ @@ -909,22 +916,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutC( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -934,7 +941,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -944,24 +951,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutCPtr( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -971,7 +978,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -981,24 +988,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutCL( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1008,7 +1015,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1018,20 +1025,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemSetCMemo( PHB_ITEM pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1041,7 +1048,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1051,26 +1058,26 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutD( PHB_ITEM pItem, long lYear, long lMonth, long lDay ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1080,7 +1087,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1090,22 +1097,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutDS( PHB_ITEM pItem, char * szDate ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1115,7 +1122,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1125,22 +1132,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutDL( PHB_ITEM pItem, long lJulian ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1150,7 +1157,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1160,22 +1167,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutL( PHB_ITEM pItem, BOOL bValue ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1185,7 +1192,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1195,22 +1202,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutND( PHB_ITEM pItem, double dNumber ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1220,7 +1227,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1230,22 +1237,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNI( PHB_ITEM pItem, int iNumber ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1255,7 +1262,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1265,22 +1272,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNL( PHB_ITEM pItem, long lNumber ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1290,7 +1297,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1300,26 +1307,26 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1329,7 +1336,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1339,26 +1346,26 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNDLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1368,7 +1375,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1378,24 +1385,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNILen( PHB_ITEM pItem, int iNumber, int iWidth ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1405,7 +1412,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1415,24 +1422,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutNLLen( PHB_ITEM pItem, long lNumber, int iWidth ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1442,7 +1449,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1452,22 +1459,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPutPtr( PHB_ITEM pItem, void * pValue ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1477,7 +1484,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1487,20 +1494,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemRelease( PHB_ITEM pItem ) --> ( BOOL )bResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1510,7 +1517,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1520,20 +1527,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemReturn( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1543,7 +1550,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1553,20 +1560,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemSize( PHB_ITEM pItem ) --> ( ULONG )ulResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1576,7 +1583,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1586,20 +1593,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemType( PHB_ITEM pItem ) --> ( USHORT )usResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1609,7 +1616,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1619,20 +1626,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemTypeStr( PHB_ITEM pItem ) --> ( char * )pszResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1642,7 +1649,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1652,22 +1659,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemParamPtr( USHORT uiParam, int iMask ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1677,7 +1684,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1687,20 +1694,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemReturnPtr( void ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ - * + * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1710,7 +1717,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1723,21 +1730,21 @@ * Our string compare * $SYNTAX$ * C Prototype - * + * * #include * hb_itemStrCmp( PHB_ITEM pFirst, PHB_ITEM pSecond, BOOL bForceExact ) --> ( int )iResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1747,7 +1754,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1760,19 +1767,19 @@ * Copies an item to one place to another respecting its containts * $SYNTAX$ * C Prototype - * + * * #include * hb_itemCopy( PHB_ITEM pDest, PHB_ITEM pSource ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1782,7 +1789,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1792,20 +1799,20 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemClear( PHB_ITEM pItem ) --> void * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1815,7 +1822,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1828,17 +1835,17 @@ * De-references passed variable * $SYNTAX$ * C Prototype - * + * * #include * hb_itemUnRef( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1848,7 +1855,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1861,21 +1868,21 @@ * Convert a number to a string * $SYNTAX$ * C Prototype - * + * * #include * hb_itemStr( PHB_ITEM pNumber, PHB_ITEM pWidth, PHB_ITEM pDec ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1885,7 +1892,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1898,21 +1905,21 @@ * Convert any scalar to a string * $SYNTAX$ * C Prototype - * + * * #include * hb_itemString( PHB_ITEM pItem, ULONG * ulLen, BOOL * bFreeReq ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1922,7 +1929,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1935,17 +1942,17 @@ * Convert any scalar to a string * $SYNTAX$ * C Prototype - * + * * #include * hb_itemValToStr( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult * $ARGUMENTS$ * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1955,7 +1962,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -1965,24 +1972,24 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemPadConv( PHB_ITEM pItem, char * buffer, ULONG * pulSize ) --> ( char * )pszResult * $ARGUMENTS$ * - * + * * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -1992,7 +1999,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ @@ -2002,22 +2009,22 @@ * $CATEGORY$ * Item API * $ONELINER$ - * + * * $SYNTAX$ * C Prototype - * + * * #include * hb_itemSwap( PHB_ITEM pItem1, PHB_ITEM pItem2 ) --> void * $ARGUMENTS$ * - * + * * * $RETURNS$ - * + * * $DESCRIPTION$ - * + * * $EXAMPLES$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -2027,7 +2034,7 @@ * $PLATFORMS$ * All * $SEEALSO$ - * + * * $END$ */ diff --git a/harbour/include/hbapirdd.h b/harbour/include/hbapirdd.h index fe5be9aed9..c4c8cd8397 100644 --- a/harbour/include/hbapirdd.h +++ b/harbour/include/hbapirdd.h @@ -154,6 +154,10 @@ extern void hb_rddShutDown( void ); #define DBOI_AUTOORDER 63 /* Get/set default order: production index */ #define DBOI_AUTOSHARE 64 /* Get/set automatic sharing control */ +/* Return values for DBOI_OPTLEVEL */ +#define DBOI_OPTIMIZED_NONE 0 +#define DBOI_OPTIMIZED_PART 1 +#define DBOI_OPTIMIZED_FULL 2 /* Codes for SELF_INFO() */ diff --git a/harbour/include/ord.ch b/harbour/include/ord.ch index 5041fd5356..d32139c9dd 100644 --- a/harbour/include/ord.ch +++ b/harbour/include/ord.ch @@ -117,5 +117,10 @@ #define DBOI_AUTOORDER 63 /* Get/set default order: production index */ #define DBOI_AUTOSHARE 64 /* Get/set automatic sharing control */ +/* Return values for DBOI_OPTLEVEL */ +#define DBOI_OPTIMIZED_NONE 0 +#define DBOI_OPTIMIZED_PART 1 +#define DBOI_OPTIMIZED_FULL 2 + #endif