diff --git a/flaim/src/fbcd.cpp b/flaim/src/fbcd.cpp index 5fc2b7e..bdb93e0 100644 --- a/flaim/src/fbcd.cpp +++ b/flaim/src/fbcd.cpp @@ -44,7 +44,7 @@ Note: If terminating byte is half-full, low-nibble value is Method: Using a MOD algorithm, stack BCD values -- popping to destination reverses the order for correct final sequence ****************************************************************************/ -RCODE FlmUINT2Storage( +FLMEXP RCODE FLMAPI FlmUINT2Storage( FLMUINT uiNum, FLMUINT * puiBufLength, // [IN] size of pBuf, must be atleast F_MAX_NUM_BUF // [OUT] actual amount of pBuf used. @@ -97,7 +97,7 @@ Method: Using a MOD algorithm, stack BCD values -- popping to destination reverses the order for correct final sequence WARNING: -2,147,483,648 may yield different results on different platforms ****************************************************************************/ -RCODE FlmINT2Storage( +FLMEXP RCODE FLMAPI FlmINT2Storage( FLMINT iNum, FLMUINT * puiBufLength, // [IN] size of pBuf, must be atleast F_MAX_NUM_BUF // [OUT] actual amount of pBuf used. @@ -157,7 +157,7 @@ RCODE FlmINT2Storage( Desc: Returns a signed value from a BCD value. The data may be a number type, or context type. ****************************************************************************/ -RCODE FlmStorage2INT( +FLMEXP RCODE FLMAPI FlmStorage2INT( FLMUINT uiValueType, FLMUINT uiValueLength, const FLMBYTE * pucValue, // Internal Storage Format @@ -198,7 +198,7 @@ RCODE FlmStorage2INT( Desc: Returns a unsigned value from a BCD value. The data may be a number type, or context type. ****************************************************************************/ -RCODE FlmStorage2UINT( +FLMEXP RCODE FLMAPI FlmStorage2UINT( FLMUINT uiValueType, FLMUINT uiValueLength, const FLMBYTE * pucValue, // Internal Storage Format @@ -238,7 +238,7 @@ RCODE FlmStorage2UINT( Desc: Returns a unsigned value from a BCD value. The data may be a number type, or context type. ****************************************************************************/ -RCODE FlmStorage2UINT32( +FLMEXP RCODE FLMAPI FlmStorage2UINT32( FLMUINT uiValueType, FLMUINT uiValueLength, const FLMBYTE * pucValue, // Internal Storage Format @@ -370,5 +370,3 @@ RCODE flmBcd2Num( return( FERR_OK); } - - diff --git a/flaim/src/fblob.cpp b/flaim/src/fblob.cpp index 37f2576..9394e50 100644 --- a/flaim/src/fblob.cpp +++ b/flaim/src/fblob.cpp @@ -648,7 +648,7 @@ void FBListAfterAbort( /**************************************************************************** Desc: Allocate a new blob object ****************************************************************************/ -RCODE FlmAllocBlob( +FLMEXP RCODE FLMAPI FlmAllocBlob( FlmBlob ** ppBlob) { RCODE rc = FERR_OK; diff --git a/flaim/src/fdbcnfig.cpp b/flaim/src/fdbcnfig.cpp index 3a3a083..9adedf7 100644 --- a/flaim/src/fdbcnfig.cpp +++ b/flaim/src/fdbcnfig.cpp @@ -37,7 +37,7 @@ void flmGetCPInfo( /******************************************************************************* Desc: Sets indexing callback function *******************************************************************************/ -void FlmSetIndexingCallback( +FLMEXP void FLMAPI FlmSetIndexingCallback( HFDB hDb, IX_CALLBACK fnIxCallback, void * pvAppData) @@ -49,7 +49,7 @@ void FlmSetIndexingCallback( /******************************************************************************* Desc: Returns indexing callback function *******************************************************************************/ -void FlmGetIndexingCallback( +FLMEXP void FLMAPI FlmGetIndexingCallback( HFDB hDb, IX_CALLBACK * pfnIxCallback, void ** ppvAppData) @@ -76,7 +76,7 @@ Notes: This function stores a pointer to a callback function which is or before records are returned to the application (read operations). By default, no record validation is performed by FLAIM. *******************************************************************************/ -void FlmSetRecValidatorHook( +FLMEXP void FLMAPI FlmSetRecValidatorHook( HFDB hDb, REC_VALIDATOR_HOOK fnRecValidatorHook, void * pvAppData) @@ -88,7 +88,7 @@ void FlmSetRecValidatorHook( /******************************************************************************* Desc : Returns to the user the sessions current Rec Validator Hook values. *******************************************************************************/ -void FlmGetRecValidatorHook( +FLMEXP void FLMAPI FlmGetRecValidatorHook( HFDB hDb, REC_VALIDATOR_HOOK * pfnRecValidatorHook, // [out] RecValidator func pointer void ** ppvAppData) // [out] application data @@ -108,7 +108,7 @@ void FlmGetRecValidatorHook( Desc : Configures a callback function which is called to return general purpose information. *******************************************************************************/ -void FlmSetStatusHook( +FLMEXP void FLMAPI FlmSetStatusHook( HFDB hDb, STATUS_HOOK fnStatusHook, void * pvAppData) @@ -120,7 +120,7 @@ void FlmSetStatusHook( /******************************************************************************* Desc : Returns to the user the session's current status hook values. *******************************************************************************/ -void FlmGetStatusHook( +FLMEXP void FLMAPI FlmGetStatusHook( HFDB hDb, STATUS_HOOK * pfnStatusHook, void ** ppvAppData) @@ -139,17 +139,11 @@ void FlmGetStatusHook( /******************************************************************************* Desc: Allows an application to configure various options for a database. *******************************************************************************/ -RCODE - // FERR_NOT_IMPLEMENTED - Invalid eConfigType value - FlmDbConfig( - HFDB hDb, - // [IN] Handle to a database. - eDbConfigType eConfigType, - // [IN] Database option to configure. - void * Value1, - // [IN] The type and domain of Value1 are determined by eConfigType. - void * Value2 - // [IN] The type and domain of Value2 are determined by eConfigType. +FLMEXP RCODE FLMAPI FlmDbConfig( + HFDB hDb, + eDbConfigType eConfigType, + void * Value1, + void * Value2 ) { RCODE rc = FERR_OK; @@ -1001,183 +995,12 @@ Exit: /******************************************************************************* Desc: Returns information about a particular database. *******************************************************************************/ -RCODE - // FERR_NOT_IMPLEMENTED - Invalid eGetConfigType value - // FRC_NOT_FOUND - Requested information is not available - FlmDbGetConfig( - HFDB hDb, - // [IN] Handle to a database. - eDbGetConfigType eGetConfigType, - // [IN] Information to retrieve. Possible values of eGetConfigType: - // - // PARAM TYPE MEANING / USE - // - // FDB_GET_VERSION: Retrieves the database's version number. - // - // Value1 FLMUINT * Returns version number. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_BLKSIZ: Retrieves the database's block size. - // - // Value1 FLMUINT * Returns block size. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_DEFAULT_LANG: Retrieves the database's default language. - // - // Value1 FLMUINT * Returns default language. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_PATH: Retrieves the store's file path. If the - // path is not available, FRC_NOT_FOUND will be returned. - // - // Value1 FLMBYTE * Returns database file name. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_TRANS_ID: Returns the stores' current transaction ID, - // if any. A value of zero is returned if there is no current - // transaction. - // - // Value1 FLMUINT * Returns transaction ID. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_CHECKPOINT_INFO: Returns checkpoint information for the - // store. - // - // Value1 CHECKPOINT_INFO * Returns checkpoint info. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_LOCK_HOLDER: Returns holder of lock. - // - // Value1 LOCK_USER * Returns current lock holder. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_LOCK_WAITERS: Returns waiters for the lock. - // - // Value1 LOCK_USER ** Returns array of LOCK_USER - // structures. Will return NULL if - // there are no waiters. NOTE: Caller - // must delete[] the array! - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_LOCK_WAITERS_EX: Calls methods of a user-supplied - // object to return information about entries in the lock table - // - // Value1 FlmLockInfo * Returns lock information object. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_RFL_DIR: Current RFL directory - // - // Value1 FLMBYTE * Returns RFL directory. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_RFL_FILE_NUM: Current RFL file number - // - // Value1 FLMUINT * Returns current RFL file number. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_RFL_HIGHEST_NU: Highest RFL file number that is - // no longer needed for recovery after a server crash - // - // Value1 FLMUINT * Returns highest RFL file number. - // - // FDB_GET_RFL_FILE_SIZE_LIMITS: Gets the minimum and - // maximum RFL file sizes. - // - // Value1 FLMUINT * Returns minimum RFL file size. - // Value2 FLMUINT * Returns maximum RFL file size. - // Value3 Not Used - // - // FDB_GET_RFL_KEEP_FLAG: Returns a boolean to indicate whether - // or not RFL files are being preserved - // - // Value1 FLMBOOL * Returns keep flag. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_LAST_BACKUP_TRANS_ID: Transaction ID of the last backup. - // The backup may have been a full backup or an incremental backup. - // - // Value1 FLMUINT * Returns transaction ID. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_BLOCKS_CHANGED_SINCE_BACKUP: Gets the approx. number of - // blocks that have changed since the last full or incremental backup. - // - // Value1 FLMUINT * Returns blocks changed. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_SERIAL_NUMBER: Gets the database's serial number - // - // Value1 FLMBYTE * Returns serial number. Buffer size - // should be at least F_SERIAL_NUM_SIZE. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_AUTO_TURN_OFF_KEEP_RFL_FLAG: Returns a boolean to - // indicate whether or not keeping of roll-forward log files - // will be automatically turned off when we run out of disk space. - // - // Value1 FLMBOOL * Returns flag. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_KEEP_ABORTED_TRANS_IN_RFL_FLAG: Returns a boolean to - // to indicate whether or not we are keeping aborted transactions - // in the roll-forward log. - // - // Value1 FLMBOOL * Returns flag. - // Value2 Not Used - // Value3 Not Used - // - // FDB_GET_SIZES: Returns database size, rollback size, - // and RFL file size. NULL pointers may be passed if one - // or more of the sizes is not requested. - // - // Value1 FLMUINT64 * Returns database size. - // Value2 FLMUINT64 * Returns rollback size. - // Value3 FLMUINT64 * Returns RFL size. - // - // FDB_GET_FILE_EXTEND_SIZE: Returns the amount by which the database - // is extending files whenever it has to extend them. - // Value1 FLMUINT * Returns extend size. - // - // FDB_GET_APP_DATA: Returns the application object for the DB. - // Value1 void ** Returns application object. - // - // FDB_GET_NEXT_INC_BACKUP_SEQ_NUM: Returns the sequence number - // of the next incremental backup. - // Value1 FLMUINT * Returns the sequence number - // - // FDB_GET_DICT_SEQ_NUM: Returns the sequence number of - // the dictionary - // Value1 FLMUINT * Returns the sequence number - // - // FDB_GET_FFILE_ID: Returns the ID of the FDB's FFILE - // Value1 FLMUINT * Returns the ID - // - // FDB_GET_MUST_CLOSE_RC: Returns the error that caused the - // "must close" flag to be set - // Value1 RCODE * RCODE of "must close" error - // - void * Value1, - // [OUT] The type and domain of Value1 is determined by eGetConfigType. - void * Value2, - // [OUT] The type and domain of Value2 is determined by eGetConfigType. - void * Value3 - // [OUT] The type and domain of Value3 is determined by eGetConfigType. +FLMEXP RCODE FLMAPI FlmDbGetConfig( + HFDB hDb, + eDbGetConfigType eGetConfigType, + void * Value1, + void * Value2, + void * Value3 ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fdbcopy.cpp b/flaim/src/fdbcopy.cpp index d4b8675..bb01ca0 100644 --- a/flaim/src/fdbcopy.cpp +++ b/flaim/src/fdbcopy.cpp @@ -55,7 +55,7 @@ FSTATIC RCODE flmCopyFile( /******************************************************************************* Desc: Copies a database, including roll-forward log files. *******************************************************************************/ -RCODE FlmDbCopy( +FLMEXP RCODE FLMAPI FlmDbCopy( const char * pszSrcDbName, const char * pszSrcDataDir, const char * pszSrcRflDir, diff --git a/flaim/src/fdbremov.cpp b/flaim/src/fdbremov.cpp index e59eb0a..dbe990d 100644 --- a/flaim/src/fdbremov.cpp +++ b/flaim/src/fdbremov.cpp @@ -27,7 +27,7 @@ /******************************************************************************* Desc: Removes a database, including roll-forward log files, if requested. *******************************************************************************/ -RCODE FlmDbRemove( +FLMEXP RCODE FLMAPI FlmDbRemove( const char * pszDbName, const char * pszDataDir, const char * pszRflDir, diff --git a/flaim/src/fdbrenam.cpp b/flaim/src/fdbrenam.cpp index 2402249..d57ffbb 100644 --- a/flaim/src/fdbrenam.cpp +++ b/flaim/src/fdbrenam.cpp @@ -165,7 +165,7 @@ Exit: /******************************************************************************* Desc: Renames a database *******************************************************************************/ -RCODE FlmDbRename( +FLMEXP RCODE FLMAPI FlmDbRename( const char * pszDbName, const char * pszDataDir, const char * pszRflDir, diff --git a/flaim/src/fitem.cpp b/flaim/src/fitem.cpp index 422f72f..11a267e 100644 --- a/flaim/src/fitem.cpp +++ b/flaim/src/fitem.cpp @@ -31,7 +31,7 @@ Notes: Given an item ID, this routine will search a specified shared or of the item will be returned. This routine supports version 2.0 and higher databases only. *******************************************************************************/ -RCODE FlmGetItemName( +FLMEXP RCODE FLMAPI FlmGetItemName( HFDB hDb, FLMUINT uiItemId, FLMUINT uiNameBufSize, diff --git a/flaim/src/flalloc.cpp b/flaim/src/flalloc.cpp index c419c93..438fec3 100644 --- a/flaim/src/flalloc.cpp +++ b/flaim/src/flalloc.cpp @@ -1441,7 +1441,7 @@ FLMUINT F_Base::Release( void) /**************************************************************************** Desc: ****************************************************************************/ -void FlmFreeMem( +FLMEXP void FLMAPI FlmFreeMem( void * pMem) { f_free( &pMem); diff --git a/flaim/src/flbackup.cpp b/flaim/src/flbackup.cpp index cb914bf..bbe13c8 100644 --- a/flaim/src/flbackup.cpp +++ b/flaim/src/flbackup.cpp @@ -169,7 +169,7 @@ private: Desc: Prepares FLAIM to backup a database. Notes: Only one backup of a particular database can be active at any time *******************************************************************************/ -RCODE FlmDbBackupBegin( +FLMEXP RCODE FLMAPI FlmDbBackupBegin( HFDB hDb, FBackupType eBackupType, FLMBOOL bHotBackup, @@ -413,7 +413,7 @@ Exit: /*API~*********************************************************************** Desc : Returns information about a backup *END************************************************************************/ -RCODE FlmBackupGetConfig( +FLMEXP RCODE FLMAPI FlmBackupGetConfig( HFBACKUP hBackup, eBackupGetConfigType eConfigType, void * pvValue1, @@ -457,7 +457,7 @@ Notes: This routine attempts to create a backup of a database without too long in an environment where extensive updates are happening, an old view error could be returned. *END************************************************************************/ -RCODE FlmDbBackup( +FLMEXP RCODE FLMAPI FlmDbBackup( HFBACKUP hBackup, const char * pszBackupPath, const char * pszPassword, @@ -975,7 +975,7 @@ Exit: /*API~*********************************************************************** Desc : Ends the backup, updating the log header if needed. *END************************************************************************/ -RCODE FlmDbBackupEnd( +FLMEXP RCODE FLMAPI FlmDbBackupEnd( HFBACKUP * phBackup) { RCODE rc = FERR_OK; @@ -1159,7 +1159,7 @@ Exit: /*API~*********************************************************************** Desc: Restores a database and supporting files. *END************************************************************************/ -RCODE FlmDbRestore( +FLMEXP RCODE FLMAPI FlmDbRestore( const char * pszDbPath, const char * pszDataDir, const char * pszBackupPath, diff --git a/flaim/src/flblddbo.cpp b/flaim/src/flblddbo.cpp index 45c1c5b..7bff7db 100644 --- a/flaim/src/flblddbo.cpp +++ b/flaim/src/flblddbo.cpp @@ -87,7 +87,7 @@ Notes: This routine performs the following actions: 1) A temporary database complete, the temporary database file is copied over the source database file. *END************************************************************************/ -RCODE FlmDbRebuild( +FLMEXP RCODE FLMAPI FlmDbRebuild( const char * pszSourceDbPath, const char * pszSourceDataDir, const char * pszDestDbPath, diff --git a/flaim/src/flchkdb.cpp b/flaim/src/flchkdb.cpp index 9b85479..f35825e 100644 --- a/flaim/src/flchkdb.cpp +++ b/flaim/src/flchkdb.cpp @@ -53,7 +53,7 @@ Note: The routine verifies the database by first reading through verify the linked lists, we can keep ourselves from getting into an infinite loop if there is a loop in the lists. *END************************************************************************/ -RCODE FlmDbCheck( +FLMEXP RCODE FLMAPI FlmDbCheck( HFDB hDb, const char * pDbFileName, const char * pszDataDir, diff --git a/flaim/src/flclose.cpp b/flaim/src/flclose.cpp index 3572a20..50269c0 100644 --- a/flaim/src/flclose.cpp +++ b/flaim/src/flclose.cpp @@ -147,9 +147,8 @@ Exit: /**************************************************************************** Desc: Closes a FLAIM database. ****************************************************************************/ -RCODE FlmDbClose( +FLMEXP RCODE FLMAPI FlmDbClose( HFDB * phDbRV) { return( flmDbClose( phDbRV, FALSE)); } - diff --git a/flaim/src/flconvrt.cpp b/flaim/src/flconvrt.cpp index d1acc36..66c0b0e 100644 --- a/flaim/src/flconvrt.cpp +++ b/flaim/src/flconvrt.cpp @@ -27,7 +27,7 @@ /*API~*********************************************************************** Desc: Upgrades a database to the latest FLAIM version. *END************************************************************************/ -RCODE FlmDbUpgrade( +FLMEXP RCODE FLMAPI FlmDbUpgrade( HFDB hDb, FLMUINT uiNewVersion, STATUS_HOOK fnStatusCallback, @@ -550,7 +550,7 @@ Exit: /*API~*********************************************************************** Desc : Adds an encryption key to the database. *END************************************************************************/ -RCODE FlmEnableEncryption( +FLMEXP RCODE FLMAPI FlmEnableEncryption( HFDB hDb, FLMBYTE ** ppucWrappingKeyRV, FLMUINT32 * pui32KeyLen) @@ -679,7 +679,7 @@ Exit: Desc: Changes the way the database key is stored in the database. Either it is encrypted using a password or it is wrapped in the server key. *END************************************************************************/ -RCODE FlmDbWrapKey( +FLMEXP RCODE FLMAPI FlmDbWrapKey( HFDB hDb, const char * pszPassword) { diff --git a/flaim/src/flcreate.cpp b/flaim/src/flcreate.cpp index ff76b38..f704bff 100644 --- a/flaim/src/flcreate.cpp +++ b/flaim/src/flcreate.cpp @@ -43,7 +43,7 @@ FSTATIC RCODE flmInitFileHdrs( /*API~*********************************************************************** Desc : Creates a new FLAIM database. *END************************************************************************/ -RCODE FlmDbCreate( +FLMEXP RCODE FLMAPI FlmDbCreate( const char * pszDbFileName, const char * pszDataDir, const char * pszRflDir, diff --git a/flaim/src/flindex.cpp b/flaim/src/flindex.cpp index 29ece57..9f72656 100644 --- a/flaim/src/flindex.cpp +++ b/flaim/src/flindex.cpp @@ -41,7 +41,7 @@ FSTATIC RCODE flmIndexStatusCS( /*API~*********************************************************************** Desc : Return the status of the index. *END************************************************************************/ -RCODE FlmIndexStatus( +FLMEXP RCODE FLMAPI FlmIndexStatus( HFDB hDb, FLMUINT uiIndexNum, FINDEX_STATUS * pIndexStatus) @@ -149,7 +149,7 @@ Exit: Desc : Return the number of the next index. Pass in zero to get the first index. *END************************************************************************/ -RCODE FlmIndexGetNext( +FLMEXP RCODE FLMAPI FlmIndexGetNext( HFDB hDb, FLMUINT * puiIndexNum) { @@ -245,14 +245,9 @@ Desc : Suspend the selected index from doing any key updates on records persistant if the database goes down. Notes: An update transaction will be started if necessary. *END************************************************************************/ -RCODE - // FERR_BAD_IX - There is not an index with the input index number. - // FERR_IO_FILE_LOCK_ERR - FlmIndexSuspend( - HFDB hDb, - // [IN] Database handle. - FLMUINT uiIndexNum) - // [IN] The number of the index to suspend. +FLMEXP RCODE FLMAPI FlmIndexSuspend( + HFDB hDb, + FLMUINT uiIndexNum) { RCODE rc = FERR_OK; FDB * pDb = (FDB *)hDb; @@ -459,14 +454,9 @@ Desc : If the index was suspended, restart the background process that Returns FERR_OK with no change if the index is already online. Notes: An update transaction will be started if necessary. *END************************************************************************/ -RCODE - // FERR_BAD_IX - There is not an index with the input index number. - // FERR_IO_FILE_LOCK_ERR - FlmIndexResume( - HFDB hDb, - // [IN] Database handle. - FLMUINT uiIndexNum) - // [IN] Index to resume +FLMEXP RCODE FLMAPI FlmIndexResume( + HFDB hDb, + FLMUINT uiIndexNum) { RCODE rc = FERR_OK; FDB * pDb = (FDB *)hDb; diff --git a/flaim/src/flkeyret.cpp b/flaim/src/flkeyret.cpp index 514c30d..c2bf21e 100644 --- a/flaim/src/flkeyret.cpp +++ b/flaim/src/flkeyret.cpp @@ -44,7 +44,7 @@ FSTATIC RCODE flmNextKey( /*API~*********************************************************************** Desc: Retrieves a key from an index based on a passed-in GEDCOM tree and DRN. *END************************************************************************/ -RCODE FlmKeyRetrieve( +FLMEXP RCODE FLMAPI FlmKeyRetrieve( HFDB hDb, FLMUINT uiIndex, FLMUINT uiContainer, @@ -636,4 +636,3 @@ FSTATIC RCODE flmNextKey( Exit: return( rc); } - diff --git a/flaim/src/flkeys.cpp b/flaim/src/flkeys.cpp index d376a57..f93975f 100644 --- a/flaim/src/flkeys.cpp +++ b/flaim/src/flkeys.cpp @@ -28,7 +28,7 @@ Desc: Given an input key tree a FLAIM collated key will be built and returned to the user. ****************************************************************************/ -RCODE FlmKeyBuild( +FLMEXP RCODE FLMAPI FlmKeyBuild( HFDB hDb, FLMUINT uiIxNum, FLMUINT uiContainer, diff --git a/flaim/src/flmstat.cpp b/flaim/src/flmstat.cpp index d6a045a..2ff4241 100644 --- a/flaim/src/flmstat.cpp +++ b/flaim/src/flmstat.cpp @@ -696,7 +696,7 @@ Exit: /**************************************************************************** Desc: This routine frees the memory associated with a FLM_STAT structure. ****************************************************************************/ -void FlmFreeStats( +FLMEXP void FLMAPI FlmFreeStats( FLM_STATS * pStats ) { @@ -1254,7 +1254,7 @@ Desc : Returns statistics that have been collected for a share. Notes: The statistics returned will be the statistics for ALL databases associated with the share structure. *END************************************************************************/ -RCODE FlmGetStats( +FLMEXP RCODE FLMAPI FlmGetStats( FLM_STATS * pFlmStats) { RCODE rc = FERR_OK; diff --git a/flaim/src/flopen.cpp b/flaim/src/flopen.cpp index 6441a0b..377190a 100644 --- a/flaim/src/flopen.cpp +++ b/flaim/src/flopen.cpp @@ -53,7 +53,7 @@ FSTATIC RCODE flmDoRecover( /*API~*********************************************************************** Desc : Opens an existing FLAIM database. *END************************************************************************/ -RCODE FlmDbOpen( +FLMEXP RCODE FLMAPI FlmDbOpen( const char * pszDbFileName, const char * pszDataDir, const char * pszRflDir, diff --git a/flaim/src/flprintf.cpp b/flaim/src/flprintf.cpp index 4aef4cb..5f53ce8 100644 --- a/flaim/src/flprintf.cpp +++ b/flaim/src/flprintf.cpp @@ -810,7 +810,7 @@ FLMINT f_vsprintf( /**************************************************************************** Desc: FLAIM's sprintf ****************************************************************************/ -FLMINT f_sprintf( +FLMEXP FLMINT FLMCDECL f_sprintf( char * pszDestStr, const char * pszFormat, ...) diff --git a/flaim/src/flrcodes.cpp b/flaim/src/flrcodes.cpp index 6c54605..efd8ba7 100644 --- a/flaim/src/flrcodes.cpp +++ b/flaim/src/flrcodes.cpp @@ -25,10 +25,10 @@ #include "flaimsys.h" /*API~*********************************************************************** -Desc: Returns a pointer to the ASCII string representation of a FLAIM - return code. +Desc: Returns a pointer to the ASCII string representation of a FLAIM + return code. *END************************************************************************/ -const char * FlmErrorString( +FLMEXP const char * FLMAPI FlmErrorString( RCODE rc) { const char * pszStr; @@ -290,7 +290,3 @@ const char * flmErrorString( return( NULL); } } - - - - diff --git a/flaim/src/flrddrct.cpp b/flaim/src/flrddrct.cpp index 3d2d5b9..ad60b79 100644 --- a/flaim/src/flrddrct.cpp +++ b/flaim/src/flrddrct.cpp @@ -34,11 +34,9 @@ FSTATIC RCODE flmRecordRetrieveCS( /*API~*********************************************************************** -Name : FlmRecordRetrieve -Area : RETRIEVAL Desc : Retrieves a single record from a container. *END************************************************************************/ -RCODE FlmRecordRetrieve( +FLMEXP RCODE FLMAPI FlmRecordRetrieve( HFDB hDb, FLMUINT uiContainer, FLMUINT uiDrn, diff --git a/flaim/src/flreduce.cpp b/flaim/src/flreduce.cpp index ceafb1c..9632ae6 100644 --- a/flaim/src/flreduce.cpp +++ b/flaim/src/flreduce.cpp @@ -59,7 +59,7 @@ Notes: The size of the database file is reduced by freeing a specified available block list is empty, FLAIM will attemp to add blocks to the list by freeing log extent blocks. *END************************************************************************/ -RCODE FlmDbReduceSize( +FLMEXP RCODE FLMAPI FlmDbReduceSize( HFDB hDb, FLMUINT uiCount, FLMUINT * puiCountRV diff --git a/flaim/src/flresdrn.cpp b/flaim/src/flresdrn.cpp index 60b193c..0e22dc5 100644 --- a/flaim/src/flresdrn.cpp +++ b/flaim/src/flresdrn.cpp @@ -25,33 +25,14 @@ #include "flaimsys.h" /*API~*********************************************************************** -Area : UPDATE Desc : Returns the next DRN that record ADD would return. The database/store must be in an existing update transaction. Notes: *END************************************************************************/ -RCODE - // FERR_ILLEGAL_TRANS - a READ transaction is going - cannot promote to - // an update transaction - // FERR_ABORT_TRANS - Previous operation failed forcing the caller - // to abort this transaction - // FERR_NO_TRANS_ACTIVE - an update transaction must be active. - // IO_FILE_LOCK_ERR - Could not get the lock on the database or store. - FlmReserveNextDrn( - HFDB hDb, - // [IN] Database handle. - FLMUINT uiContainer, - // [IN] Container number. - FLMUINT * puiDrnRV - // [OUT] Pointer to a FLMUINT variable which will return the next DRN - // value for the container as if FlmRecordAdd is called with *drnRV - // equal to zero. - // - // NOTE: When FLAIM is allowed to assign the DRN, it always selects - // the highest available DRN. If, for example, a user successfully - // adds a record with DRN 5000 to a previously empty container and - // then adds a second record (allowing FLAIM to automatically assign - // the DRN) the second record will be assigned DRN 5001. +FLMEXP RCODE FLMAPI FlmReserveNextDrn( + HFDB hDb, + FLMUINT uiContainer, + FLMUINT * puiDrnRV ) { RCODE rc; @@ -172,13 +153,12 @@ ExitCS: /*API~*********************************************************************** -Area : UPDATE Desc : Searches for an available DRN in the dictionary container. Differs from FlmReserveNextDrn in that it will attempt to reuse dictionary DRNS. The database/store must be in an existing update transaction. Notes: *END************************************************************************/ -RCODE FlmFindUnusedDictDrn( +FLMEXP RCODE FLMAPI FlmFindUnusedDictDrn( HFDB hDb, FLMUINT uiStartDrn, FLMUINT uiEndDrn, diff --git a/flaim/src/flsweep.cpp b/flaim/src/flsweep.cpp index bc7ea51..5dd3b08 100644 --- a/flaim/src/flsweep.cpp +++ b/flaim/src/flsweep.cpp @@ -158,7 +158,7 @@ Notes: During a database sweep, the user may perform one or all of the all items within the database and gather statistics about the database and it's contents. ****************************************************************************/ -RCODE FlmDbSweep( +FLMEXP RCODE FLMAPI FlmDbSweep( HFDB hDb, FLMUINT uiSweepMode, FLMUINT uiCallbackFreq, diff --git a/flaim/src/fltrabrt.cpp b/flaim/src/fltrabrt.cpp index 6c99b79..c866264 100644 --- a/flaim/src/fltrabrt.cpp +++ b/flaim/src/fltrabrt.cpp @@ -329,16 +329,10 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Aborts an active transaction. *END************************************************************************/ -RCODE - // FERR_ILLEGAL_TRANS_OP - Active child transactions must be committed - // or aborted before the parent transaction can be aborted. - // - // FERR_NO_TRANS_ACTIVE - No transaction is active - FlmDbTransAbort( - HFDB hDb +FLMEXP RCODE FLMAPI FlmDbTransAbort( + HFDB hDb ) { RCODE rc; diff --git a/flaim/src/fltrbeg.cpp b/flaim/src/fltrbeg.cpp index a35335d..6b26230 100644 --- a/flaim/src/fltrbeg.cpp +++ b/flaim/src/fltrbeg.cpp @@ -438,28 +438,13 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Starts a transaction. *END************************************************************************/ -RCODE - FlmDbTransBegin( - HFDB hDb, - // [IN] Database handle. - FLMUINT uiTransType, - // [IN] Specifies the type of transaction to begin. - // Possible values are: - // - // FLM_READ_TRANS: Begins a read transaction. - // FLM_UPDATE_TRANS: Begins an update transaction. - FLMUINT uiMaxLockWait, - // [IN] Maximum lock wait time. Specifies the amount of time - // to wait for lock requests occuring during the transaction - // to be granted. Valid values are 0 through 255 seconds. Zero - // is used to specify no-wait locks. - FLMBYTE * pszHeader - // [IN] 2K buffer - // [OUT] Returns the first 2K of the file, including the current - // version of the log header (from memory) +FLMEXP RCODE FLMAPI FlmDbTransBegin( + HFDB hDb, + FLMUINT uiTransType, + FLMUINT uiMaxLockWait, + FLMBYTE * pucHeader ) { RCODE rc = FERR_OK; @@ -482,7 +467,7 @@ RCODE { if( RC_BAD( rc = Wire.doTransOp( FCS_OP_TRANSACTION_BEGIN, uiTransType, uiFlags, - uiMaxLockWait, pszHeader))) + uiMaxLockWait, pucHeader))) { goto Exit; } @@ -546,10 +531,10 @@ RCODE { FLMUINT uiBytesRead; - if( pszHeader) + if( pucHeader) { if( RC_BAD( rc = pDb->pSFileHdl->ReadHeader( - 0, 2048, pszHeader, &uiBytesRead))) + 0, 2048, pucHeader, &uiBytesRead))) { goto Exit; } @@ -557,7 +542,7 @@ RCODE if (RC_BAD( rc = flmBeginDbTrans( pDb, uiTransType, uiMaxLockWait, uiFlags, - pszHeader ? &pszHeader [16] : NULL))) + pucHeader ? &pucHeader [16] : NULL))) { goto Exit; } @@ -580,7 +565,7 @@ Exit: /*API~*********************************************************************** Desc : Returns the type of the current database transaction. *END************************************************************************/ -RCODE FlmDbGetTransType( +FLMEXP RCODE FLMAPI FlmDbGetTransType( HFDB hDb, FLMUINT * puiTransTypeRV ) @@ -656,21 +641,13 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Obtains a a lock on the database. *END************************************************************************/ -RCODE - FlmDbLock( - HFDB hDb, - // [IN] Handle of database to be locked. - FLOCK_TYPE eLockType, - // [IN] Type of lock request - must be FLM_LOCK_EXCLUSIVE or - // FLM_LOCK_SHARED - FLMINT iPriority, - // [IN] Priority to be assigned to lock. - FLMUINT uiTimeout - // [IN] Seconds to wait for lock to be granted. FLM_NO_TIMEOUT - // means that it will wait forever for the lock to be granted. +FLMEXP RCODE FLMAPI FlmDbLock( + HFDB hDb, + FLOCK_TYPE eLockType, + FLMINT iPriority, + FLMUINT uiTimeout ) { RCODE rc = FERR_OK; @@ -786,13 +763,10 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Releases a lock on the database *END************************************************************************/ -RCODE - FlmDbUnlock( - HFDB hDb - // [IN] Handle of database to be unlocked. +FLMEXP RCODE FLMAPI FlmDbUnlock( + HFDB hDb ) { RCODE rc = FERR_OK; @@ -885,7 +859,7 @@ Exit: Desc : Returns information about current and pending locks on the database. *END************************************************************************/ -RCODE FlmDbGetLockInfo( +FLMEXP RCODE FLMAPI FlmDbGetLockInfo( HFDB hDb, FLMINT iPriority, FLOCK_INFO * pLockInfo @@ -920,7 +894,7 @@ Exit: Desc : Returns information about the lock held by the specified database handle. *END************************************************************************/ -RCODE FlmDbGetLockType( +FLMEXP RCODE FLMAPI FlmDbGetLockType( HFDB hDb, FLOCK_TYPE * peLockType, FLMBOOL * pbImplicit) @@ -981,17 +955,11 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Forces a checkpoint on the database. *END************************************************************************/ -RCODE - FlmDbCheckpoint( - HFDB hDb, - // [IN] Handle of database to perform the checkpoint on. - FLMUINT uiTimeout - // [IN] Seconds to wait to obtain lock on the database. - // FLM_NO_TIMEOUT means that it will wait forever for - // the lock to be granted. +FLMEXP RCODE FLMAPI FlmDbCheckpoint( + HFDB hDb, + FLMUINT uiTimeout ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fltrcmit.cpp b/flaim/src/fltrcmit.cpp index 31875f2..bb4d473 100644 --- a/flaim/src/fltrcmit.cpp +++ b/flaim/src/fltrcmit.cpp @@ -512,21 +512,11 @@ Exit: } /*API~*********************************************************************** -Area : TRANSACTION Desc : Commits an active transaction. *END************************************************************************/ -RCODE - // FERR_ILLEGAL_TRANS_OP - Active child transactions must be committed - // before the parent transaction can be committed. - // - // FERR_ABORT_TRANS - The transaction cannot be committed and must - // be aborted. - // - // FERR_NO_TRANS_ACTIVE - No transaction is active - FlmDbTransCommit( - HFDB hDb, - // [IN] Database handle. - FLMBOOL * pbEmpty // May be NULL +FLMEXP RCODE FLMAPI FlmDbTransCommit( + HFDB hDb, + FLMBOOL * pbEmpty // May be NULL ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fltrnum.cpp b/flaim/src/fltrnum.cpp index a389a64..857f86a 100644 --- a/flaim/src/fltrnum.cpp +++ b/flaim/src/fltrnum.cpp @@ -30,7 +30,7 @@ Notes: This routine should only be called only from within an update transaction since read transactions are not assigned a transaction number. *END************************************************************************/ -RCODE FlmDbGetTransId( +FLMEXP RCODE FLMAPI FlmDbGetTransId( HFDB hDb, FLMUINT * puiTrNumRV ) @@ -97,7 +97,7 @@ Notes: Whenever a transaction is committed, FLAIM increments the commit An application may use this routine to determine if the database has been modified. *END************************************************************************/ -RCODE FlmDbGetCommitCnt( +FLMEXP RCODE FLMAPI FlmDbGetCommitCnt( HFDB hDb, FLMUINT * puiCommitCount ) diff --git a/flaim/src/flupdate.cpp b/flaim/src/flupdate.cpp index 0677eff..fa49d7b 100644 --- a/flaim/src/flupdate.cpp +++ b/flaim/src/flupdate.cpp @@ -155,7 +155,7 @@ Notes: If an index definition record is added to the dictionary container, keys in an index are not unique, the transaction commit will fail and return an error. *END************************************************************************/ -RCODE FlmRecordAdd( +FLMEXP RCODE FLMAPI FlmRecordAdd( HFDB hDb, FLMUINT uiContainer, FLMUINT * puiDrn, @@ -458,7 +458,7 @@ Notes: If an index definition record is modified in the dictionary container, index definition record is not allowed. For information on changing the state of a field, see the Dictionary Syntax document. *END************************************************************************/ -RCODE FlmRecordModify( +FLMEXP RCODE FLMAPI FlmRecordModify( HFDB hDb, FLMUINT uiContainer, FLMUINT uiDrn, @@ -752,7 +752,7 @@ Notes: If an index definition record or a container definition record is information on deletion of field definitions, see the Dictionary Syntax document. *END************************************************************************/ -RCODE FlmRecordDelete( +FLMEXP RCODE FLMAPI FlmRecordDelete( HFDB hDb, FLMUINT uiContainer, FLMUINT uiDrn, diff --git a/flaim/src/flutil.cpp b/flaim/src/flutil.cpp index d0f4f25..a6ca4d9 100644 --- a/flaim/src/flutil.cpp +++ b/flaim/src/flutil.cpp @@ -56,7 +56,7 @@ /**************************************************************************** Desc: Unsigned word to NATIVE value - null terminate the native string ****************************************************************************/ -char * f_uwtoa( +FLMEXP char * FLMAPI f_uwtoa( FLMUINT16 value, char * ptr) { @@ -73,7 +73,7 @@ char * f_uwtoa( Desc: Native to UDWORD value. Supports 0x codes. Non digits NOT ALLOWED NO LEADING SPACES ALLOWED ! ! ! No checks for overflow over 4 bytes! ****************************************************************************/ -FLMUINT f_atoud( +FLMEXP FLMUINT FLMAPI f_atoud( const char * pszBuf) { FLMUINT uiValue; @@ -132,7 +132,7 @@ FLMUINT f_atoud( /**************************************************************************** Desc: Unsigned double (4 byte) number to native value & null terminate ****************************************************************************/ -char * f_udtoa( +FLMEXP char * FLMAPI f_udtoa( FLMUINT value, char * ptr) { @@ -148,7 +148,7 @@ char * f_udtoa( /**************************************************************************** Desc: Word to native value - null terminate the native string ****************************************************************************/ -char * f_wtoa( +FLMEXP char * FLMAPI f_wtoa( FLMINT16 value, char * ptr) { @@ -166,7 +166,7 @@ char * f_wtoa( /**************************************************************************** Desc: Double (4 byte) number to native value - null terminate the string ****************************************************************************/ -char * f_dtoa( +FLMEXP char * FLMAPI f_dtoa( FLMINT value, char * ptr) { @@ -184,7 +184,7 @@ char * f_dtoa( /**************************************************************************** Desc: Ascii to integer ****************************************************************************/ -FLMINT f_atoi( +FLMEXP FLMINT FLMAPI f_atoi( const char * ptr) { return( f_atod( ptr)); @@ -193,7 +193,7 @@ FLMINT f_atoi( /**************************************************************************** Desc: native to long ****************************************************************************/ -FLMINT f_atol( +FLMEXP FLMINT FLMAPI f_atol( const char * ptr) { return( f_atod( ptr)); @@ -203,7 +203,7 @@ FLMINT f_atol( Desc: Native to DWORD value. Supports 0x codes. Non digits NOT ALLOWED NO LEADING SPACES ALLOWED ! ! ! No checks for overflow over 4 bytes! ****************************************************************************/ -FLMINT f_atod( +FLMEXP FLMINT FLMAPI f_atod( const char * pszBuf) { FLMINT iValue; @@ -255,7 +255,7 @@ FINLINE FLMUINT maxDecimalSize( /**************************************************************************** Desc: Compares two Unicode strings ****************************************************************************/ -FLMINT f_unicmp( +FLMEXP FLMINT FLMAPI f_unicmp( const FLMUNICODE * puzStr1, const FLMUNICODE * puzStr2) { @@ -271,7 +271,7 @@ FLMINT f_unicmp( /**************************************************************************** Desc: Returns the length of a unicode string ****************************************************************************/ -FLMUINT f_unilen( +FLMEXP FLMUINT FLMAPI f_unilen( const FLMUNICODE * puzStr) { FLMUINT uiLen = 0; @@ -295,7 +295,7 @@ Exit: /**************************************************************************** Desc: Finds a substring ****************************************************************************/ -FLMUNICODE * f_uniindex( +FLMEXP FLMUNICODE * FLMAPI f_uniindex( const FLMUNICODE * puzStr, const FLMUNICODE * puzSearch) { @@ -347,7 +347,7 @@ FLMUNICODE * f_uniindex( /**************************************************************************** Desc: The equivalent of strncmp for unicode strings. ****************************************************************************/ -FLMINT f_unincmp( +FLMEXP FLMINT FLMAPI f_unincmp( const FLMUNICODE * puzStr1, const FLMUNICODE * puzStr2, FLMUINT uiLen) @@ -369,7 +369,7 @@ FLMINT f_unincmp( /**************************************************************************** Desc: Compares two strings, one Unicode and one native ****************************************************************************/ -FLMINT f_uninativecmp( +FLMEXP FLMINT FLMAPI f_uninativecmp( const FLMUNICODE * puzStr1, const char * pszStr2) { @@ -385,7 +385,7 @@ FLMINT f_uninativecmp( /**************************************************************************** Desc: Compares two strings, one Unicode and one native ****************************************************************************/ -FLMINT f_uninativencmp( +FLMEXP FLMINT FLMAPI f_uninativencmp( const FLMUNICODE * puzStr1, const char * pszStr2, FLMUINT uiCount) @@ -409,7 +409,7 @@ FLMINT f_uninativencmp( /**************************************************************************** Desc: Copies a unicode string ****************************************************************************/ -FLMUNICODE * f_unicpy( +FLMEXP FLMUNICODE * FLMAPI f_unicpy( FLMUNICODE * puzDestStr, const FLMUNICODE * puzSrcStr) { @@ -428,7 +428,7 @@ FLMUNICODE * f_unicpy( /**************************************************************************** Desc: Copies a native string into a Unicode buffer ****************************************************************************/ -void f_nativetounistrcpy( +FLMEXP void FLMAPI f_nativetounistrcpy( FLMUNICODE * puzDest, const char * pszSrc) { @@ -609,7 +609,7 @@ void flmQSortUINTSwap( /**************************************************************************** Desc: Determine if a token is a number. ****************************************************************************/ -FLMBOOL tokenIsNum( +FLMEXP FLMBOOL FLMAPI tokenIsNum( const char * pszToken, FLMUINT * puiNum) { diff --git a/flaim/src/fmisc.cpp b/flaim/src/fmisc.cpp index ee60ed2..71dda09 100644 --- a/flaim/src/fmisc.cpp +++ b/flaim/src/fmisc.cpp @@ -25,14 +25,11 @@ #include "flaimsys.h" /*API~*********************************************************************** -Name : FlmErrorIsFileCorrupt -Area : INFORMATION Desc : Returns TRUE if the passed in RCODE indicates that a corruption has occured in a FLAIM database file. *END************************************************************************/ -FLMBOOL FlmErrorIsFileCorrupt( +FLMEXP FLMBOOL FLMAPI FlmErrorIsFileCorrupt( RCODE rc) - // [IN] Return code to be checked. { FLMBOOL b = FALSE; @@ -60,8 +57,6 @@ FLMBOOL FlmErrorIsFileCorrupt( /*API~*********************************************************************** -Name : FlmGetDiagInfo -Area : INFORMATION Desc : Returns specific information about the most recent error that occured within FLAIM. Notes: FLAIM maintains information about the operation which generated @@ -69,7 +64,7 @@ Notes: FLAIM maintains information about the operation which generated or other information specific to the operation and can be useful in identifying the cause of the error. *END************************************************************************/ -RCODE FlmGetDiagInfo( +FLMEXP RCODE FLMAPI FlmGetDiagInfo( HFDB hDb, eDiagInfoType eDiagCode, void * pvDiagInfo diff --git a/flaim/src/fnative.cpp b/flaim/src/fnative.cpp index 137b356..40e2e95 100644 --- a/flaim/src/fnative.cpp +++ b/flaim/src/fnative.cpp @@ -30,7 +30,7 @@ Desc: Returns the size of buffer needed to hold the native string in FLAIM's storage format. ****************************************************************************/ -FLMUINT FlmGetNativeStorageLength( +FLMEXP FLMUINT FLMAPI FlmGetNativeStorageLength( const char * pszStr) { RCODE rc; @@ -47,7 +47,7 @@ Desc: Copies and formats a native 8-bit null terminated string into a caller supplied buffer, It converts the string into an internal FLAIM TEXT string. ****************************************************************************/ -RCODE FlmNative2Storage( +FLMEXP RCODE FLMAPI FlmNative2Storage( const char * pszNativeString, FLMUINT * puiStorageLen, FLMBYTE * pStorageBuffer) @@ -156,7 +156,7 @@ RCODE FlmNative2Storage( /**************************************************************************** Desc: Convert a storage text string into a native string ****************************************************************************/ -RCODE FlmStorage2Native( +FLMEXP RCODE FLMAPI FlmStorage2Native( FLMUINT uiValueType, FLMUINT uiValueLength, const FLMBYTE * pucValue, diff --git a/flaim/src/fqcur.cpp b/flaim/src/fqcur.cpp index 2439df7..11cb513 100644 --- a/flaim/src/fqcur.cpp +++ b/flaim/src/fqcur.cpp @@ -132,22 +132,14 @@ RCODE flmCurDbInit( } /*API~*********************************************************************** -Name : FlmCursorInit -Area : CURSOR Desc : Initializes a cursor for subsequent definition and navigation of a record set. A cursor must be initialized before it can be used. *END************************************************************************/ -RCODE FlmCursorInit( - HFDB hDb, - // [IN] Initial source database. - FLMUINT uiContainer, - // [IN] Initial source container. - HFCURSOR * phCursor - // [OUT] Cursor handle to be initialized. If initialization fails, - // the returned cursor handle will have a value of HFCURSOR_NULL. - // Otherwise, the cursor handle will be ready for use in subsequent - // calls to cursor routines. +FLMEXP RCODE FLMAPI FlmCursorInit( + HFDB hDb, + FLMUINT uiContainer, + HFCURSOR * phCursor ) { RCODE rc = FERR_OK; @@ -367,18 +359,12 @@ Exit: } /*API~*********************************************************************** -Area : CURSOR Desc : Initializes a new cursor and sets its selection criteria and record sources to be the same as those of the passed-in cursor. *END************************************************************************/ -RCODE FlmCursorClone( +FLMEXP RCODE FLMAPI FlmCursorClone( HFCURSOR hSource, - // [IN] Source cursor. HFCURSOR * phCursor - // [OUT] Cursor handle to be initialized. If initialization fails, - // the returned cursor handle will have a value of HFCURSOR_NULL. - // Otherwise, the cursor handle will be ready for use in subsequent - // calls to cursor routines. ) { RCODE rc = FERR_OK; @@ -631,14 +617,12 @@ CS_Exit: } /*API~*********************************************************************** -Name : FlmCursorReleaseResources -Area : CURSOR Desc: Frees resources of the cursor without actually freeing the cursor. Keeps around the stuff that is needed to display the cursor information for debugging purposes after the fact. At this point the cursor is no longer usable. *END************************************************************************/ -void FlmCursorReleaseResources( +FLMEXP void FLMAPI FlmCursorReleaseResources( HFCURSOR hCursor ) { @@ -654,18 +638,12 @@ void FlmCursorReleaseResources( } /*API~*********************************************************************** -Name : FlmCursorFree -Area : CURSOR Desc : Frees memory allocated to an initialized cursor. The cursor handle cannot be used for additional cursor operations unless it is re-initialized. *END************************************************************************/ -RCODE FlmCursorFree( +FLMEXP RCODE FLMAPI FlmCursorFree( HFCURSOR * phCursor - // [IN/OUT] Cursor handle to be de-allocated. - // The cursor handle must have been previously initialized. - // The value of the handle is guaranteed to be HFCURSOR_NULL - // if the operation is successful. ) { CURSOR_p pCursor = (CURSOR *)*phCursor; @@ -698,24 +676,12 @@ RCODE FlmCursorFree( } /*API~*********************************************************************** -Name : FlmCursorSetMode -Area : CURSOR Desc : Sets flags in the query that determine text comparision modes and the granularity for QuickFinder indexes. *END************************************************************************/ -RCODE FlmCursorSetMode( +FLMEXP RCODE FLMAPI FlmCursorSetMode( HFCURSOR hCursor, - // [IN] Handle to a cursor. FLMUINT uiFlags) - // [IN] Possible values of uiFlags: - // - // FLM_NOCASE: Indicates that case-insensitive comparisions should be - // made when comparing field content to a string value. (Text - // comparison mode) - // - // FLM_WILD: Indicates that '*' and '?' characters will be treated - // as wild cards in a string value when comparing to field content. - // (Text comparison mode) { CURSOR_p pCursor = (CURSOR *)hCursor; @@ -1583,108 +1549,11 @@ Exit: Desc : Allows configuration of cursor attributes, including assignment of QuickFinder strings, indexes and search records. *END************************************************************************/ -RCODE FlmCursorConfig( +FLMEXP RCODE FLMAPI FlmCursorConfig( HFCURSOR hCursor, - // [IN] Handle to a cursor. eCursorConfigType eConfigType, - // [IN] Cursor element to configure. Possible values of uiType: - // - // PARAM TYPE MEANING / USE - // - // FCURSOR_ALLOW_DUPS: Allow duplicate keys to be returned. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_ELIMINATE_DUPS: Eliminate duplicate keys. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_CLEAR_QUERY: Clears the query criteria. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_DISCONNECT: Calls into QuickFinder to free memory - // associated with files used by QF. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_GEN_POS_KEYS: Generates an array of positioning keys for - // a cursor. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_SET_HDB: Resets the database handle associated with this - // cursor. - // Value1 HFDB Database handle to be used for cursor. - // Value2 N/A N/A - // - // FCURSOR_SET_FLM_IX: Sets the index to be used by the cursor. - // Value1 FLMUINT Index number. - // Value2 N/A N/A - // - // FCURSOR_SET_OP_TIME_LIMIT: Sets a time limit for the next read - // operation. - // Value1 FLMUINT Time limit in seconds. - // Value2 N/A N/A - // - // FCURSOR_SET_PERCENT_POS: Sets the percentage position in the - // cursor's result set. - // Value1 FLMUINT Percentage value (1 - 100) to which the - // cursor position is to be set. - // Value2 N/A N/A - // - // FCURSOR_SET_ABS_POS: Sets the absolute position in the - // cursor's result set. - // Value1 FLMUINT * Absolute position to which the cursor - // is to be set. Also returns the - // position actually set to (if we fall - // forward or backward). - // Value2 FLMBOOL If the position specified doesn't - // pass the criteria, this flag specifies - // whether to fall forward or backward. - // TRUE=fall forward, FALSE=fall backward. - // - // FCURSOR_SET_POS: Sets the cursor position from that of another - // cursor. - // Value1 HFCURSOR Handle to cursor from which position is - // to be set. - // Value2 N/A N/A - // - // FCURSOR_SET_POS_FROM_DRN: Sets the cursor position from a DRN. - // Value1 FLMUINT DRN from which position is to be set. - // Value2 N/A N/A - // - // FCURSOR_SET_REC_TYPE: Sets the record type associated with a - // cursor. Only records of the specified type will be returned by - // by the cursor. - // Value1 FLMUINT Record type ID. - // Value2 N/A N/A - // - // FCURSOR_RETURN_KEYS_OK: Sets the cursor to return keys, if possible. - // Value1 FLMBOOL TRUE = return keys, FALSE = return records - // Value2 N/A N/A - // - // FCURSOR_SET_REC_VALIDATOR: Set record validator for cursor. - // Value1 REC_VALIDATOR_HOOK N/A - // Value2 Data to be passed to callback. - // - // FCURSOR_SET_STATUS_HOOK: Set status callback for cursor. - // Value1 STATUS_HOOK N/A - // Value2 Data to be passed to callback. - // - // FCURSOR_SAVE_POSITION: Save current position of cursor. - // Value1 N/A N/A - // Value2 N/A N/A - // - // FCURSOR_RESTORE_POSITION: Restore cursor to last saved - // position. - // Value1 N/A N/A - // Value2 N/A N/A - // - void * Value1, - // [IN] The type and domain of Value1 are determined by eConfigType. - void * Value2 - // [IN] The type and domain of Value2 are determined by eConfigType. + void * Value1, + void * Value2 ) { RCODE rc = FERR_OK; @@ -1904,7 +1773,6 @@ Exit: } /************************************************************************ -Name : flmCurPositionable Desc : Returns whether or not a query is positionable. *************************************************************************/ FSTATIC RCODE flmCurPositionable( @@ -1948,7 +1816,6 @@ Exit: } /************************************************************************ -Name : flmCurAbsPositionable Desc : Returns whether or not a query is absolute positionable. *************************************************************************/ FSTATIC RCODE flmCurAbsPositionable( @@ -2000,7 +1867,6 @@ Exit: } /************************************************************************ -Name : flmCurGetAbsolutePos Desc : Returns absolute position of cursor. *************************************************************************/ FSTATIC RCODE flmCurGetAbsolutePos( @@ -2080,7 +1946,6 @@ Exit: } /************************************************************************ -Name : flmCurGetAbsoluteCount Desc : Returns absolute count for the cursor's index. NOTE: This is not necessarily the same thing as the number of records that will pass the filter criteria. @@ -2146,102 +2011,13 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorGetConfig -Area : CURSOR Desc : Returns FLAIM cursor configuration values. *END************************************************************************/ -RCODE FlmCursorGetConfig( +FLMEXP RCODE FLMAPI FlmCursorGetConfig( HFCURSOR hCursor, - // [IN] Handle to a cursor. eCursorGetConfigType eGetConfigType, - // [IN] Cursor element to retrieve. Possible values of uiType: - // - // PARAM TYPE MEANING / USE - // - // FCURSOR_GET_PERCENT_POS: Returns the percentage position of the - // cursor's current position. - // Value1 FLMUINT * Pointer to where percentage - // position is to be returned. - // - // FCURSOR_GET_ABS_POS: Finds the absolute position of the - // cursor's current position. - // Value1 FLMUINT * Pointer to where absolute - // position is to be returned. - // - // FCURSOR_GET_ABS_COUNT: Returns the absolute count of the - // cursor's index range. NOTE: This is not necessarily the count of - // records that will pass the query criteria. - // Value1 FLMUINT * Pointer to where count - // is to be returned. - // - // FCURSOR_GET_OPT_INFO_LIST: Populates a preallocated array of - // OPT_INFO structures with information from the subqueries in - // the current cursor. NOTE: the size of the array should be - // determined by calling this API with a NULL OPT_INFO *. - // Value1 OPT_INFO * Preallocated array of OPT_INFO - // structures to be populated. - // Value2 FLMUINT * Size of the array. A null Value1 will - // return the total number of sub queries. - // - // FCURSOR_GET_OPT_INFO: Retrieves information about how a particular - // subquery is being optimized. - // Value1 N/A N/A - // Value2 OPT_INFO * Preallocated OPT_INFO structure. - // - // FCURSOR_GET_FLM_IX: Retrieves the number of the index being used - // to optimize query. 0 is returned if there is no index associated - // with the current cursor or if multiple indexes are being used. In - // the case of multiple indexes, Value2 can be used to differentiate - // the use of multiple indexes from the no index case. - // Value1 FLMUINT * Storage location for returning the - // index number. - // Value2 FLMUINT * Index information - // HAVE_NO_INDEX - // HAVE_ONE_INDEX - // HAVE_ONE_INDEX_MULT_PARTS - // HAVE_MULTIPLE_INDEXES - // - // FCURSOR_GET_REC_TYPE: Retrieves the record type associated with - // a cursor. - // Value1 FLMUINT * Storage location for returning the - // record type. - // Value2 N/A N/A - // - // FCURSOR_GET_FLAGS: Retrieves flags set by FlmCursorSetMode. - // Value1 FLMUINT * Storage location for returning the - // cursor flags. - // Value2 N/A N/A - // - // FCURSOR_GET_STATE: Retrieves flags describing the state of the query. - // Value1 FLMUINT * Storage location for returning the - // state flags. - // Value2 N/A N/A - // - // FCURSOR_GET_POSITIONABLE: Determines if a cursor is positionable. - // Value1 FLMBOOL * Storage location for returning whether - // or not the cursor is positionable. - // Value2 N/A N/A - // - // FCURSOR_GET_ABS_POSITIONABLE: Determines if a cursor is - // absolute positionable. - // Value1 FLMBOOL * Storage location for returning whether - // or not the cursor is absolute positionable. - // Value2 N/A N/A - // - // FCURSOR_AT_BOF: Determines if a cursor is at BOF. - // Value1 FLMBOOL * Storage location for returning whether - // or not the cursor is at BOF. - // Value2 N/A N/A - // - // FCURSOR_AT_EOF: Determines if a cursor is at EOF. - // Value1 FLMBOOL * Storage location for returning whether - // or not the cursor is at EOF. - // Value2 N/A N/A - // - void * Value1, - // [IN/OUT] The type and domain of Value1 is determined by uiType. - void * Value2 - // [OUT] The type and domain of Value2 is determined by uiType. + void * Value1, + void * Value2 ) { RCODE rc = FERR_OK; @@ -2603,7 +2379,7 @@ Warning: The index selected from this call will be used for query optimization in addition to ordering the results. This could result in slower query performance. *END************************************************************************/ -RCODE FlmCursorSetOrderIndex( +FLMEXP RCODE FLMAPI FlmCursorSetOrderIndex( HFCURSOR hCursor, FLMUINT * puiFieldPaths, /* List of field paths to match on. Each path is terminated with a single 0, and the diff --git a/flaim/src/fqdecl.cpp b/flaim/src/fqdecl.cpp index a9cad62..5ab243e 100644 --- a/flaim/src/fqdecl.cpp +++ b/flaim/src/fqdecl.cpp @@ -557,8 +557,6 @@ Transmission_Error: } /*API~*********************************************************************** -Name : FlmCursorValidate -Area : CURSOR Desc : Validates the selection criteria of a cursor. Notes: It is not necessary to explicitly validate the selection criteria through a call to this routine. FLAIM will automatically attempt @@ -568,7 +566,7 @@ Notes: It is not necessary to explicitly validate the selection criteria before calling cursor routines which will make use of it. Ret: FERR_CURSOR_SYNTAX - The selection criteria contains a syntax error *END************************************************************************/ -RCODE FlmCursorValidate( +FLMEXP RCODE FLMAPI FlmCursorValidate( HFCURSOR hCursor // [IN] Handle to a cursor. ) diff --git a/flaim/src/fqget.cpp b/flaim/src/fqget.cpp index c1a159e..ddf4b01 100644 --- a/flaim/src/fqget.cpp +++ b/flaim/src/fqget.cpp @@ -306,7 +306,7 @@ Exit: /*API~*********************************************************************** Desc: Given a cursor and two DRNs, this API does the following: *END************************************************************************/ -RCODE FlmCursorCompareDRNs( +FLMEXP RCODE FLMAPI FlmCursorCompareDRNs( HFCURSOR hCursor, FLMUINT uiDRN1, FLMUINT uiDRN2, @@ -769,22 +769,16 @@ Transmission_Error: /*API~*********************************************************************** -Name : FlmCursorTestRec -Area : CURSOR Desc : Checks a record that has been retrieved from the database to see if satisfies the cursor selection criteria. IMPORTANT NOTE: pRec's containerID better be set to the container it came from, because flmCurEvalCriteria verifies that the record's container number matches the cursor's container number. *END************************************************************************/ -RCODE FlmCursorTestRec( +FLMEXP RCODE FLMAPI FlmCursorTestRec( HFCURSOR hCursor, - // [IN] Handle to a cursor. FlmRecord * pRec, - // [IN] Pointer to the record to be checked. FLMBOOL * pbIsMatch - // [OUT] If *pbIsMatch == TRUE, then the record is a match. - // Otherwise, the record did not meet the criteria and is not a match. ) { RCODE rc = FERR_OK; @@ -869,24 +863,15 @@ Exit2: } /*API~*********************************************************************** -Name : FlmCursorTestDRN -Area : CURSOR Desc : Retrieves the record identified by the passed-in DRN and checks it to see if it satisfies the cursor selection criteria. Notes: This function is designed for use with cursors having only one associated source. Multiple sources are not supported. *END************************************************************************/ -RCODE - // FERR_NOT_IMPLEMENTED - The source list associated with the cursor - // is either empty or contains more than one source. - FlmCursorTestDRN( - HFCURSOR hCursor, - // [IN] Handle to a cursor. - FLMUINT uiDrn, - // [IN] DRN of the record to be checked. - FLMBOOL * pbIsMatch - // [OUT] If *pbIsMatch == TRUE, then the record is a match. - // Otherwise, the record did not meet the criteria and is not a match. +FLMEXP RCODE FLMAPI FlmCursorTestDRN( + HFCURSOR hCursor, + FLMUINT uiDrn, + FLMBOOL * pbIsMatch ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fqparse.cpp b/flaim/src/fqparse.cpp index deb82a6..4d518df 100644 --- a/flaim/src/fqparse.cpp +++ b/flaim/src/fqparse.cpp @@ -1269,7 +1269,7 @@ Exit: /*API~*********************************************************************** Desc: Parse a query criteria string and populate an HFCURSOR from it. *END************************************************************************/ -RCODE FlmParseQuery( +FLMEXP RCODE FLMAPI FlmParseQuery( HFCURSOR hCursor, F_NameTable * pNameTable, const char * pszQueryCriteria) diff --git a/flaim/src/fqread.cpp b/flaim/src/fqread.cpp index 04ad4b1..2e570cb 100644 --- a/flaim/src/fqread.cpp +++ b/flaim/src/fqread.cpp @@ -189,7 +189,7 @@ Transmission_Error: /**************************************************************************** Desc: Gets the requested record. ****************************************************************************/ -RCODE flmCurPerformRead( +FLMEXP RCODE FLMAPI flmCurPerformRead( eFlmFuncs eFlmFuncId, HFCURSOR hCursor, FLMBOOL bReadForward, @@ -392,16 +392,11 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorCurrent -Area : CURSOR Desc : Retrieves the record currently pointed to by a cursor. *END************************************************************************/ -RCODE FlmCursorCurrent( +FLMEXP RCODE FLMAPI FlmCursorCurrent( HFCURSOR hCursor, - // [IN] Handle to a cursor. FlmRecord ** ppRecord - // [OUT] Pointer to a FlmRecord. *ppRecord will be non-NULL if the - // call is successful. Otherwise, *ppRecord will be NULL. ) { RCODE rc = FERR_OK; @@ -440,16 +435,11 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorCurrentDRN -Area : CURSOR Desc : Retrieves the DRN of the current record in a set defined by a cursor. *END************************************************************************/ -RCODE FlmCursorCurrentDRN( +FLMEXP RCODE FLMAPI FlmCursorCurrentDRN( HFCURSOR hCursor, - // [IN] Handle to a cursor. FLMUINT * puiDrn - // [OUT] Pointer to a DRN. If the call is successful, the value - // of *puiDrn will be the DRN of the current record. ) { RCODE rc = FERR_OK; @@ -494,7 +484,7 @@ Notes: Requests that position beyond the end of the result set will BOF_HIT error to be returned. Passing a relative position of 0 is invalid and will cause ILLEGAL_OP to be returned. *END************************************************************************/ -RCODE FlmCursorMoveRelative( +FLMEXP RCODE FLMAPI FlmCursorMoveRelative( HFCURSOR hCursor, FLMINT * piPosition, FlmRecord ** ppRecord @@ -527,17 +517,11 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorRecCount -Area : CURSOR Desc : Returns the number of records in a set defined by a cursor. *END************************************************************************/ -RCODE FlmCursorRecCount( +FLMEXP RCODE FLMAPI FlmCursorRecCount( HFCURSOR hCursor, - // [IN] Handle to a cursor. FLMUINT * puiCount - // [OUT] Pointer to a FLMUINT. If the call is successful, the value - // of *puiCount will be number of records in the set defined by the - // cursor. ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fqstack.cpp b/flaim/src/fqstack.cpp index c22e1ea..16221a5 100644 --- a/flaim/src/fqstack.cpp +++ b/flaim/src/fqstack.cpp @@ -61,7 +61,7 @@ static FLMUINT PrecedenceTable [FLM_USER_PREDICATE - FLM_AND_OP + 1] = /*API~*********************************************************************** Desc : Adds an operator to the selection criteria of a given cursor. *END************************************************************************/ -RCODE FlmCursorAddOp( +FLMEXP RCODE FLMAPI FlmCursorAddOp( HFCURSOR hCursor, QTYPES eOperator, FLMBOOL bResolveUnknown @@ -307,7 +307,7 @@ Exit: /*API~*********************************************************************** Desc: Adds an embedded user predicate. *END************************************************************************/ -RCODE FlmCursorAddUserPredicate( +FLMEXP RCODE FLMAPI FlmCursorAddUserPredicate( HFCURSOR hCursor, FlmUserPredicate * pPredicate ) @@ -695,7 +695,7 @@ Exit: /*API~*********************************************************************** Desc : Adds a value to the selection criteria of a given cursor. *END************************************************************************/ -RCODE FlmCursorAddValue( +FLMEXP RCODE FLMAPI FlmCursorAddValue( HFCURSOR hCursor, QTYPES eValType, void * pVal, @@ -852,21 +852,12 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorAddField -Area : CURSOR Desc : Adds a field ID to the selection criteria of a given cursor. *END************************************************************************/ -RCODE FlmCursorAddField( +FLMEXP RCODE FLMAPI FlmCursorAddField( HFCURSOR hCursor, - // [IN] Handle to a cursor. FLMUINT uiFldId, - // [IN] Field number. FLMUINT uiFlags - // [IN] Flags. Valid values for uiFlags are as follows: - // FLM_USE_DEFAULT_VALUE -- If a field is missing from a record, - // use a default value. - // FLM_SINGLE_VALUED -- Field will only have a single occurrance - // in any record it appears in. ) { RCODE rc = FERR_OK; @@ -934,46 +925,13 @@ Exit: /*API~*********************************************************************** -Name : FlmCursorAddFieldPath -Area : CURSOR Desc : Adds a field path to the selection criteria of a given cursor. A field path is the fully qualified context of a field within a record. *END************************************************************************/ -RCODE FlmCursorAddFieldPath( +FLMEXP RCODE FLMAPI FlmCursorAddFieldPath( HFCURSOR hCursor, - // [IN] Handle to a cursor. FLMUINT * puiFldPath, - // [IN] Null-terminated array of field numbers. The first member - // is the root field and the last member is the leaf field. - // - // Example: - // - // Assume that a sample database has a data dictionary with the fields - // PERSON (context field, id 567), BUILDING (context field, id 568), - // and NAME (string, id 569) defined. Also, the following records - // have been added to the default data container: - // - // 0 PERSON 0 BUILDING - // 1 NAME "john doe" 1 NAME "empire state" - // - // If it is desired to select all records from the database - // in which the NAME field is found within the context of the PERSON - // field (occurences of NAME field which are directly subordinate - // to the PERSON field), a field path can be used: - // - // FLMUINT puiFldPath[] = { 567, 569, 0}; - // - // The field path can be view simply as a "qualified" field, - // and as such, adding a field path to the selection criteria is no - // different syntactically than adding a field to the criteria. - // All operations, operators, and constructs which are valid when - // applied to a field are also valid when applied to a field path. FLMUINT uiFlags - // [IN] Flags. Valid values for uiFlags are as follows: - // FLM_USE_DEFAULT_VALUE -- If a field is missing from a record, - // use a default value. - // FLM_SINGLE_VALUED -- Field will only have a single occurrance - // in any record it appears in. ) { RCODE rc = FERR_OK; @@ -1030,54 +988,17 @@ Exit: } /*API~*********************************************************************** -Name : FlmCursorAddFieldCB -Area : CURSOR Desc : Adds a field path to the selection criteria of a given cursor - with a callback to retrieve the field. *END************************************************************************/ -RCODE FlmCursorAddFieldCB( - HFCURSOR hCursor, - // [IN] Handle to a cursor. - FLMUINT * puiFldPath, - // [IN] Null-terminated array of field numbers. The first member - // is the root field and the last member is the leaf field. - // - // Example: - // - // Assume that a sample database has a data dictionary with the fields - // PERSON (context field, id 567), BUILDING (context field, id 568), - // and NAME (string, id 569) defined. Also, the following records - // have been added to the default data container: - // - // 0 PERSON 0 BUILDING - // 1 NAME "john doe" 1 NAME "empire state" - // - // If it is desired to select all records from the database - // in which the NAME field is found within the context of the PERSON - // field (occurences of NAME field which are directly subordinate - // to the PERSON field), a field path can be used: - // - // FLMUINT puiFldPath[] = { 567, 569, 0 }; - // - // The field path can be view simply as a "qualified" field, - // and as such, adding a field path to the selection criteria is no - // different syntactically than adding a field to the criteria. - // All operations, operators, and constructs which are valid when - // applied to a field are also valid when applied to a field path. - FLMUINT uiFlags, - // [IN] Flags. Valid values for uiFlags are as follows: - // FLM_USE_DEFAULT_VALUE -- If a field is missing from a record, - // use a default value. - // FLM_SINGLE_VALUED -- Field will only have a single occurrance - // in any record it appears in. - FLMBOOL bValidateOnly, - // [IN] Validate fields only. If TRUE, this indicates that fields are - // to be validated via the callback, not fetched. +FLMEXP RCODE FLMAPI FlmCursorAddFieldCB( + HFCURSOR hCursor, + FLMUINT * puiFldPath, + FLMUINT uiFlags, + FLMBOOL bValidateOnly, CURSOR_GET_FIELD_CB fnGetField, - // [IN] Callback function to retrieve the field. void * pvUserData, - // [IN] User data for callback function - FLMUINT uiUserDataLen + FLMUINT uiUserDataLen ) { RCODE rc = FERR_OK; diff --git a/flaim/src/fqtextc.cpp b/flaim/src/fqtextc.cpp index efeb2ae..ca5f6b7 100644 --- a/flaim/src/fqtextc.cpp +++ b/flaim/src/fqtextc.cpp @@ -91,7 +91,6 @@ FINLINE FLMUINT flmCharTypeAnsi7( /*API~*********************************************************************** -Name : FlmStrCmp Desc : Compare two unicode strings. This comparison uses the collation rules that are defined for the specified language. Return: Signed value of compare. @@ -99,7 +98,7 @@ Return: Signed value of compare. The case of returning 1 may be in using wild cards which only need to return a does not match value. *END************************************************************************/ -FLMINT FlmStrCmp( +FLMEXP FLMINT FLMAPI FlmStrCmp( FLMUINT uiCompFlags, FLMUINT byLang, const FLMUNICODE * uzStr1, diff --git a/flaim/src/frestore.cpp b/flaim/src/frestore.cpp index 902b2ea..8faf6d2 100644 --- a/flaim/src/frestore.cpp +++ b/flaim/src/frestore.cpp @@ -181,7 +181,7 @@ Exit: Desc: Returns an unknown stream object - suitable for writing unknown streams into the roll-forward log. *END************************************************************************/ -RCODE FlmDbGetUnknownStreamObj( +FLMEXP RCODE FLMAPI FlmDbGetUnknownStreamObj( HFDB hDb, F_UnknownStream ** ppUnknownStream) { diff --git a/flaim/src/fslfileu.cpp b/flaim/src/fslfileu.cpp index adb44b7..627f913 100644 --- a/flaim/src/fslfileu.cpp +++ b/flaim/src/fslfileu.cpp @@ -3105,7 +3105,7 @@ Exit: /*************************************************************************** Desc: ****************************************************************************/ -RCODE FlmMaintenanceStatus( +FLMEXP RCODE FLMAPI FlmMaintenanceStatus( HFDB hDb, FMAINT_STATUS * pMaintStatus) { diff --git a/flaim/src/fsysdata.cpp b/flaim/src/fsysdata.cpp index 2c83bb4..0e64a79 100644 --- a/flaim/src/fsysdata.cpp +++ b/flaim/src/fsysdata.cpp @@ -611,7 +611,7 @@ Notes: This routine may be called multiple times. However, if that is done successfully. This routine does not handle race conditions on platforms that do not support atomic increment. *END************************************************************************/ -RCODE FlmStartup( void) +FLMEXP RCODE FLMAPI FlmStartup( void) { RCODE rc = FERR_OK; FLMINT iEventCategory; @@ -1073,15 +1073,11 @@ Exit: /*API~*********************************************************************** Desc : Configures how memory will be dynamically regulated. *END************************************************************************/ -RCODE FlmSetDynamicMemoryLimit( +FLMEXP RCODE FLMAPI FlmSetDynamicMemoryLimit( FLMUINT uiCacheAdjustPercent, - // [IN] Percentage of available physical memory to set or adjust to. FLMUINT uiCacheAdjustMin, - // [IN] Minimum bytes to adjust down to. FLMUINT uiCacheAdjustMax, - // [IN] Maximum bytes to adjust up to. FLMUINT uiCacheAdjustMinToLeave - // [IN] Minimum bytes to leave available after making adjustment. ) { #ifndef FLM_CAN_GET_PHYS_MEM @@ -1119,21 +1115,13 @@ RCODE FlmSetDynamicMemoryLimit( /*API~*********************************************************************** Desc : Sets a hard memory limit for cache. *END************************************************************************/ -RCODE FlmSetHardMemoryLimit( - FLMUINT uiPercent, - // [IN] Percentage of available physical memory or total physical - // memory to set limit to. If zero, uiMax is used as a byte - // limit. - FLMBOOL bPercentOfAvail, - // [IN] Percentage is to be interpreted as a percentage of available - // memory as opposed to a percentage of all of physical memory. - FLMUINT uiMin, - // [IN] Minimum bytes to adjust down to. - FLMUINT uiMax, - // [IN] Maximum bytes to adjust up to. - FLMUINT uiMinToLeave, - // [IN] Minimum bytes to leave available after making adjustment. - FLMBOOL bPreallocate +FLMEXP RCODE FLMAPI FlmSetHardMemoryLimit( + FLMUINT uiPercent, + FLMBOOL bPercentOfAvail, + FLMUINT uiMin, + FLMUINT uiMax, + FLMUINT uiMinToLeave, + FLMBOOL bPreallocate ) { RCODE rc = FERR_OK; @@ -1170,7 +1158,7 @@ RCODE FlmSetHardMemoryLimit( /*API~*********************************************************************** Desc : Returns information about memory usage. *END************************************************************************/ -void FlmGetMemoryInfo( +FLMEXP void FLMAPI FlmGetMemoryInfo( FLM_MEM_INFO * pMemInfo) { f_memset( pMemInfo, 0, sizeof( FLM_MEM_INFO)); @@ -1503,7 +1491,7 @@ Exit: /*API~*********************************************************************** Desc: Configures share attributes. *END************************************************************************/ -RCODE FlmConfig( +FLMEXP RCODE FLMAPI FlmConfig( eFlmConfigTypes eConfigType, void * Value1, void * Value2) @@ -1987,15 +1975,9 @@ Exit: /*API~*********************************************************************** Desc : Gets configured shared attributes. *END************************************************************************/ -RCODE FlmGetConfig( - eFlmConfigTypes eConfigType, - // [IN] Element to configure. Possible values of eConfigType: - // - // PARAM TYPE MEANING / USE - // - void * Value1 - // [OUT] Pointer to return value. The type and domain of the - // value returned are determined by eConfigType. +FLMEXP RCODE FLMAPI FlmGetConfig( + eFlmConfigTypes eConfigType, + void * Value1 ) { RCODE rc = FERR_OK; @@ -2155,7 +2137,7 @@ RCODE FlmGetConfig( /*API~*********************************************************************** Desc: *END************************************************************************/ -RCODE FlmGetThreadInfo( +FLMEXP RCODE FLMAPI FlmGetThreadInfo( POOL * pPool, F_THREAD_INFO ** ppThreadInfo, FLMUINT * puiNumThreads, @@ -2965,7 +2947,7 @@ Notes: Allows itself to be called multiple times and even before FlmStartup race conditions very well on platforms that do not support atomic exchange. *END************************************************************************/ -void FlmShutdown( void) +FLMEXP void FLMAPI FlmShutdown( void) { flmLockSysData(); flmCleanup(); @@ -3603,7 +3585,7 @@ RCODE flmMonitor( /*API~*********************************************************************** Desc : Registers a callback function to receive events. *END************************************************************************/ -RCODE FlmRegisterForEvent( +FLMEXP RCODE FLMAPI FlmRegisterForEvent( FEventCategory eCategory, FEVENT_CB fnEventCB, void * pvAppData, @@ -3656,7 +3638,7 @@ Exit: /*API~*********************************************************************** Desc : Deregisters a callback function that was registered to receive events. *END************************************************************************/ -void FlmDeregisterForEvent( +FLMEXP void FLMAPI FlmDeregisterForEvent( HFEVENT * phEventRV) { if (phEventRV && *phEventRV != HFEVENT_NULL) @@ -5173,7 +5155,7 @@ void * F_SessionDb::getKey( /**************************************************************************** Desc: ****************************************************************************/ -RCODE FlmAllocFileSystem( +FLMEXP RCODE FLMAPI FlmAllocFileSystem( F_FileSystem ** ppFileSystem) { RCODE rc = FERR_OK; @@ -5194,7 +5176,7 @@ Exit: /**************************************************************************** Desc: ****************************************************************************/ -RCODE FlmAllocDirHdl( +FLMEXP RCODE FLMAPI FlmAllocDirHdl( F_DirHdl ** ppDirHdl) { RCODE rc = FERR_OK; @@ -5215,7 +5197,7 @@ Exit: /**************************************************************************** Desc: ****************************************************************************/ -RCODE FlmAllocFileHandle( +FLMEXP RCODE FLMAPI FlmAllocFileHandle( F_FileHdl ** ppFileHandle) { RCODE rc = FERR_OK; diff --git a/flaim/src/ftkpath.cpp b/flaim/src/ftkpath.cpp index 73c586d..d1ab6e6 100644 --- a/flaim/src/ftkpath.cpp +++ b/flaim/src/ftkpath.cpp @@ -146,7 +146,7 @@ Example: pDirPath = "\system" pFileName "autoexec.ncf" ****************************************************************************/ -void f_pathParse( +FLMEXP void FLMAPI f_pathParse( const char * pszInputPath, char * pszServer, char * pszVolume, @@ -369,7 +369,7 @@ Desc: This function will strip off the filename or trailing Notes: This function handles drive based, UNC, Netware, and UNIX type paths. ****************************************************************************/ -RCODE f_pathReduce( +FLMEXP RCODE FLMAPI f_pathReduce( const char * pszPath, char * pszDir, char * pszPathComponent) @@ -472,7 +472,7 @@ Exit: /**************************************************************************** Desc: Append a component to a path name. ****************************************************************************/ -RCODE f_pathAppend( +FLMEXP RCODE FLMAPI f_pathAppend( char * pszPath, const char * pszPathComponent) { @@ -526,7 +526,7 @@ RCODE f_pathAppend( Desc: Convert an PATH into a fully qualified, storable C string reference to a file or directory. ****************************************************************************/ -RCODE f_pathToStorageString( +FLMEXP RCODE FLMAPI f_pathToStorageString( const char * pszPath, char * pszStorageString) { @@ -654,7 +654,7 @@ Desc: Generates a file name given a seed and some modifiers, it is built to be called in a loop until the file can be sucessfully written or created with the increment being changed every time. ****************************************************************************/ -void f_pathCreateUniqueName( +FLMEXP void FLMAPI f_pathCreateUniqueName( FLMUINT * puiTime, char * pFileName, const char * pFileExt, @@ -713,7 +713,7 @@ void f_pathCreateUniqueName( /**************************************************************************** Desc: Compares the current file against a pattern template ****************************************************************************/ -FLMBOOL f_doesFileMatch( +FLMEXP FLMBOOL FLMAPI f_doesFileMatch( const char * pszFileName, const char * pszTemplate) { diff --git a/flaim/src/funicode.cpp b/flaim/src/funicode.cpp index 6d87799..f54073b 100644 --- a/flaim/src/funicode.cpp +++ b/flaim/src/funicode.cpp @@ -32,7 +32,7 @@ FSTATIC FLMUINT flmUnicodeToWP( Desc: Returns the size of buffer needed to hold the unicode string in FLAIM's storage format. ****************************************************************************/ -FLMUINT FlmGetUnicodeStorageLength( +FLMEXP FLMUINT FLMAPI FlmGetUnicodeStorageLength( const FLMUNICODE * puzStr) { FLMBYTE chrSet; @@ -108,7 +108,7 @@ Desc: Copies and formats a Unicode string into FLAIM's storage format. Unicode values that are not represented as WordPerfect 6.x characters are preserved as non-WP characters. ****************************************************************************/ -RCODE FlmUnicode2Storage( +FLMEXP RCODE FLMAPI FlmUnicode2Storage( const FLMUNICODE * puzStr, FLMUINT * puiBufLength, FLMBYTE * pBuf) @@ -264,7 +264,7 @@ Exit: /**************************************************************************** Desc: Converts storage formats to UNICODE. ****************************************************************************/ -RCODE FlmStorage2Unicode( +FLMEXP RCODE FLMAPI FlmStorage2Unicode( FLMUINT uiValueType, FLMUINT uiValueLength, const FLMBYTE * pucValue, diff --git a/flaim/src/fwpchar.cpp b/flaim/src/fwpchar.cpp index f67d8b1..7d83b78 100644 --- a/flaim/src/fwpchar.cpp +++ b/flaim/src/fwpchar.cpp @@ -124,7 +124,7 @@ FINLINE FLMUINT16 getNextCharState( /**************************************************************************** Desc: Determine the language number from the 2 byte language code ****************************************************************************/ -FLMUINT FlmLanguage( +FLMEXP FLMUINT FLMAPI FlmLanguage( char * pszLanguageCode) { char cFirstChar = *pszLanguageCode; @@ -151,7 +151,7 @@ FLMUINT FlmLanguage( /**************************************************************************** Desc: Determine the language code from the language number ****************************************************************************/ -void FlmGetLanguage( +FLMEXP void FLMAPI FlmGetLanguage( FLMUINT uiLangNum, char * pszLanguageCode) { diff --git a/flaim/src/gdpool.cpp b/flaim/src/gdpool.cpp index a0c9e0a..8b766fa 100644 --- a/flaim/src/gdpool.cpp +++ b/flaim/src/gdpool.cpp @@ -39,9 +39,9 @@ FSTATIC RCODE GedPoolFreeToMark( /**************************************************************************** Desc: Initializes a memory pool ****************************************************************************/ -void GedPoolInit( - POOL * pPool, - FLMUINT uiBlkSize) +FLMEXP void FLMAPI GedPoolInit( + POOL * pPool, + FLMUINT uiBlkSize) { pPool->uiBytesAllocated = 0; pPool->lblk = NULL; @@ -52,7 +52,7 @@ void GedPoolInit( /**************************************************************************** Desc: Returns a "marker" to the current offset in the memory pool ****************************************************************************/ -void * GedPoolMark( +FLMEXP void * FLMAPI GedPoolMark( POOL * pPool) { return (void *)((pPool->lblk) @@ -135,7 +135,7 @@ Note: If the number of bytes is more than the what is left in the current block then a new block will be allocated and the lbkl element of the PMS will be updated. *END************************************************************************/ -void * GedPoolAlloc( +FLMEXP void * FLMAPI GedPoolAlloc( POOL * pPool, FLMUINT uiSize) { @@ -206,7 +206,7 @@ Exit: /*API~******************************************************************** Desc: Allocates memory from a pool and initializes all bytes to zero. *END*********************************************************************/ -void * GedPoolCalloc( +FLMEXP void * FLMAPI GedPoolCalloc( POOL * pPool, FLMUINT uiSize) { @@ -223,7 +223,7 @@ void * GedPoolCalloc( Desc: Releases all memory allocated to a pool. Note: All memory allocated to the pool is returned to the operating system. *END************************************************************************/ -RCODE GedPoolFree( +FLMEXP RCODE FLMAPI GedPoolFree( POOL * pPool) { MBLK * blk = pPool->lblk; @@ -253,7 +253,7 @@ Desc: Resets memory blocks allocated to a pool. Note: Will reset the free space in the first memory block, and if any extra blocks exist they will be freed (destroyed). *END************************************************************************/ -RCODE GedPoolReset( +FLMEXP RCODE FLMAPI GedPoolReset( POOL * pPool, void * markPtr) { @@ -379,5 +379,3 @@ FSTATIC RCODE GedPoolFreeToMark( return( FERR_OK); } - - diff --git a/flaim/src/rfl.cpp b/flaim/src/rfl.cpp index 6208e80..89493b0 100644 --- a/flaim/src/rfl.cpp +++ b/flaim/src/rfl.cpp @@ -7564,7 +7564,7 @@ Exit: /*API~*********************************************************************** Desc: Returns the name of an RFL file given its number *END************************************************************************/ -RCODE FlmDbGetRflFileName( +FLMEXP RCODE FLMAPI FlmDbGetRflFileName( HFDB hDb, FLMUINT uiFileNum, char * pszFileName)