FIDAL - Financial Data Access Library

  Home | Documentation | Download
 

 

NAME
    FD_Initialize - C Function


SYNOPSIS
    #include "fidal.h"

    FD_RetCode FD_Initialize();


DESCRIPTION

This function MUST be called prior to any other function provided by the FIDAL.

On success and once FIDAL is not needed anymore, FD_Shutdown must be called. This will take care to de-allocate all FIDAL related resources.

After FD_Initialize, all other functions (except FD_Shutdown) are fully multithread safe.

For the user wishing to use the data management functionality, the initialization will be usually followed by the creation of at least one unified database with FD_UDBaseAlloc.
 

RETURN VALUE

FD_SUCCESSOperation is successful
FD_BAD_PARAMOne of the parameter has an unexpected value.
FD_ALLOC_ERRCannot allocate memory, or memory corruption detected
FD_UNKNOWN_ERROperation failed for unknown reason

For other error code, or to match a number to an error description, check the FD_RetCode enumeration in "FIDAL/c/include/fd_common.h"

SEE ALSO

FD_UDBaseAlloc, FD_Shutdown

        
EXAMPLE

#include "ta_libc.h"

int main( void )
{
   FD_RetCode retCode;

   retCode = FD_Initialize();

   if( retCode != FD_SUCCESS )
      printf( "Cannot initialize FIDAL (%d)!\n", retCode );
   else
   {
      printf( "FIDAL correctly initialized.\n" );

      /* ... other FIDAL functions can be used here. */
   
      FD_Shutdown();
   }

   return 0;
}

Google  SourceForge Logo
  Web FidalSoft.org
 

Copyright? 2006 TicTacTec LLC. All Rights Reserved. Last Update: 07/21/06, Unique Visitor: