Initialization, setting protocols and flags.
More...
|
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) |
|
Initialization, setting protocols and flags.
◆ kvaDbAddFile()
This loads a database file into a handle created with kvaDbOpen().
- Note
- This function is deprecated and will be replaced by kvaDbCreate()
- Parameters
-
[in] | dh | A handle database handle |
[in] | filename | A database file |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbCreate()
◆ kvaDbClose()
◆ kvaDbCreate()
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] | dh | A database handle |
[in] | localName | The name of the database or NULL . The database name is used to create qualified names for messages and signals. |
[in] | filename | The database file or NULL |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbOpen(), kvaDbGetMsgQualifiedName(), kvaDbGetSignalQualifiedName()
- Examples:
- candb_sample.c.
◆ kvaDbGetFlags()
◆ kvaDbGetProtocol()
◆ kvaDbGetProtocolProperties()
◆ kvaDbOpen()
◆ kvaDbReadFile()
◆ kvaDbSetDummyFileName()
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] | dh | A database handle |
[in] | filename | The the dummy filename to use for this database |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbCreate()
◆ kvaDbSetFlags()
◆ kvaDbSetProtocol()
Writes the protocol attribute value of a database
- Parameters
-
◆ kvaDbWriteFile()