Databases

Initialization, setting protocols and flags. More...

Functions

KvaDbStatus kvaDbOpen (KvaDbHnd *dh)
 
KvaDbStatus kvaDbAddFile (KvaDbHnd dh, const char *filename)
 
KvaDbStatus kvaDbSetDummyFileName (KvaDbHnd dh, const char *filename)
 
KvaDbStatus kvaDbCreate (KvaDbHnd dh, const char *localName, const char *filename)
 
KvaDbStatus kvaDbClose (KvaDbHnd dh)
 
KvaDbStatus kvaDbWriteFile (KvaDbHnd dh, char *filename)
 
KvaDbStatus kvaDbReadFile (KvaDbHnd dh, char *filename)
 
KvaDbStatus kvaDbGetFlags (KvaDbHnd dh, unsigned int *flags)
 
KvaDbStatus kvaDbGetProtocol (KvaDbHnd dh, KvaDbProtocolType *prot)
 
KvaDbStatus kvaDbGetProtocolProperties (KvaDbProtocolType prot, KvaDbProtocolProperties *prop)
 
KvaDbStatus kvaDbSetFlags (KvaDbHnd dh, unsigned int flags)
 
KvaDbStatus kvaDbSetProtocol (KvaDbHnd dh, KvaDbProtocolType prot)
 

Detailed Description

Initialization, setting protocols and flags.

Function Documentation

◆ kvaDbAddFile()

KvaDbStatus kvaDbAddFile ( KvaDbHnd  dh,
const char *  filename 
)

This loads a database file into a handle created with kvaDbOpen().

Note
This function is deprecated and will be replaced by kvaDbCreate()
Parameters
[in]dhA handle database handle
[in]filenameA database file
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbCreate()

◆ kvaDbClose()

KvaDbStatus kvaDbClose ( KvaDbHnd  dh)

This function closes an open database handle.

Parameters
[in]dhA handle to a database
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbOpen()
Examples:
candb_sample.c.

◆ kvaDbCreate()

KvaDbStatus kvaDbCreate ( KvaDbHnd  dh,
const char *  localName,
const char *  filename 
)

This function creates a new database in a handle created with kvaDbOpen(). There are three ways to call this function:

  • To load data from an existing database file, set localName to NULL and set filename to the database file.
  • To add an empty database, set localName to any name and set filename to NULL.
  • To load data from an existing database file and give it a new name, set localName to the new name and set filename to the database file.
Parameters
[in]dhA database handle
[in]localNameThe name of the database or NULL. The database name is used to create qualified names for messages and signals.
[in]filenameThe database file or NULL
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbOpen(), kvaDbGetMsgQualifiedName(), kvaDbGetSignalQualifiedName()
Examples:
candb_sample.c.

◆ kvaDbGetFlags()

KvaDbStatus kvaDbGetFlags ( KvaDbHnd  dh,
unsigned int *  flags 
)

Get the database flags.

Parameters
[in]dhA handle to a database
[out]flagsThe database flags, KVADB_DATABASE_xxx
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbReadFile()
Examples:
candb_sample.c.

◆ kvaDbGetProtocol()

KvaDbStatus kvaDbGetProtocol ( KvaDbHnd  dh,
KvaDbProtocolType prot 
)

Reads the protocol attribute value of a database

Parameters
[in]dhA handle to a database
[out]protA handle to protocol type, KvaDbProtocolType
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbSetProtocol(), kvaDbGetProtocolProperties

◆ kvaDbGetProtocolProperties()

KvaDbStatus kvaDbGetProtocolProperties ( KvaDbProtocolType  prot,
KvaDbProtocolProperties prop 
)

Returns properties of a given protocol, see KvaDbProtocolProperties

Parameters
[in]protProtocol type, KvaDbProtocolType
[out]propA handle to protocol properties, KvaDbProtocolProperties
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbGetProtocol()

◆ kvaDbOpen()

KvaDbStatus kvaDbOpen ( KvaDbHnd dh)

This function creates a new database handle.

Parameters
[out]dhA handle to a new database
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbClose()
Examples:
candb_sample.c.

◆ kvaDbReadFile()

KvaDbStatus kvaDbReadFile ( KvaDbHnd  dh,
char *  filename 
)

Load a database from file into a handle created with kvaDbOpen().

Parameters
[out]dhA handle to a database
[in]filenameThe name of the database file.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbCreate()
Examples:
candb_sample.c.

◆ kvaDbSetDummyFileName()

KvaDbStatus kvaDbSetDummyFileName ( KvaDbHnd  dh,
const char *  filename 
)

This function creates a new database in a handle created with kvaDbOpen(). It is used when there is no file to read data from.

Note
This function is deprecated and will be replaced by kvaDbCreate().
Parameters
[in]dhA database handle
[in]filenameThe the dummy filename to use for this database
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbCreate()

◆ kvaDbSetFlags()

KvaDbStatus kvaDbSetFlags ( KvaDbHnd  dh,
unsigned int  flags 
)

Set the database flags.

Note
This feature is currently not enabled.
Parameters
[in]dhA database handle
[in]flagsThe flags to set, KVADB_MESSAGE_xxx
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbGetFlags()

◆ kvaDbSetProtocol()

KvaDbStatus kvaDbSetProtocol ( KvaDbHnd  dh,
KvaDbProtocolType  prot 
)

Writes the protocol attribute value of a database

Parameters
[in]dhA handle to a database
[in]protProtocol type value, KvaDbProtocolType

◆ kvaDbWriteFile()

KvaDbStatus kvaDbWriteFile ( KvaDbHnd  dh,
char *  filename 
)

Write a database to file.

Parameters
[in]dhA handle to a database
[in]filenameThe name of the database file
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbReadFile()
Examples:
candb_sample.c.