FD_UDBaseAlloc.html

FIDAL - Financial Data Access Library

NAME
FD_UDBaseAlloc - C Function

SYNOPSIS
#include "fidal.h"

FD_RetCode FD_UDBaseAlloc( FD_UDBase **newUDBase );

DATA STRUCTURE
FD_UDBase stands for Unified Data Base
FD_UDBase internals are private to FIDAL and should never be accessed directly.

DESCRIPTION

Allocate an unified database. On success, and once the unified database is not needed anymore, all resources can be freed with FD_UDBaseFree.
The unified database are a "merging point" between one or more data source. In other word all the data of these data source are transparently merged within the same FD_UDBase.
For most of the user, only one unified database will be sufficient for their application.
Once an unified database is created, the usual next step is to add the data source with FD_AddDataSource.
For advanced user: more than one unified database can be allocated and independently used. Example of applications are: complex database rearrangement, multithread background data retrieval and data duplication/conversion.

RETURN VALUE

FD_SUCCESS Operation is successful
FD_ALLOC_ERR Process cannot allocate memory, or memory corruption detected
FD_UNKNOWN_ERR Operation 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_UDBaseFree, FD_Initialize , FD_AddDataSource

EXAMPLE (1)

<<TO BE COMPLETED>>

EXAMPLE (2)

<<TO BE COMPLETED>>