Add, delete and modify messages.
More...
|
KvaDbStatus | kvaDbGetFirstMsg (KvaDbHnd dh, KvaDbMessageHnd *mh) |
|
KvaDbStatus | kvaDbGetNextMsg (KvaDbHnd dh, KvaDbMessageHnd *mh) |
|
KvaDbStatus | kvaDbGetMsgById (KvaDbHnd dh, unsigned int id, KvaDbMessageHnd *mh) |
|
KvaDbStatus | kvaDbGetMsgByName (KvaDbHnd dh, const char *msg_name, KvaDbMessageHnd *mh) |
|
KvaDbStatus | kvaDbGetMsgName (KvaDbMessageHnd mh, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbGetMsgQualifiedName (KvaDbMessageHnd mh, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbGetMsgComment (KvaDbMessageHnd mh, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbGetMsgId (KvaDbMessageHnd mh, unsigned int *id, unsigned int *flags) |
|
KvaDbStatus | kvaDbGetMsgIdEx (KvaDbMessageHnd mh, unsigned int *id) |
|
KvaDbStatus | kvaDbGetMsgFlags (KvaDbMessageHnd mh, unsigned int *flags) |
|
KvaDbStatus | kvaDbGetMsgDlc (KvaDbMessageHnd mh, int *dlc) |
|
KvaDbStatus | kvaDbGetMsgSendNode (KvaDbMessageHnd mh, KvaDbNodeHnd *nh) |
|
KvaDbStatus | kvaDbAddMsg (KvaDbHnd dh, KvaDbMessageHnd *mh) |
|
KvaDbStatus | kvaDbDeleteMsg (KvaDbHnd dh, KvaDbMessageHnd mh) |
|
KvaDbStatus | kvaDbSetMsgName (KvaDbMessageHnd mh, char *buf) |
|
KvaDbStatus | kvaDbSetMsgComment (KvaDbMessageHnd mh, char *buf) |
|
KvaDbStatus | kvaDbSetMsgId (KvaDbMessageHnd mh, unsigned int id, unsigned int flags) |
|
KvaDbStatus | kvaDbSetMsgIdEx (KvaDbMessageHnd mh, unsigned int id) |
|
KvaDbStatus | kvaDbSetMsgFlags (KvaDbMessageHnd mh, unsigned int flags) |
|
KvaDbStatus | kvaDbSetMsgDlc (KvaDbMessageHnd mh, int dlc) |
|
KvaDbStatus | kvaDbSetMsgSendNode (KvaDbMessageHnd mh, KvaDbNodeHnd nh) |
|
KvaDbStatus | kvaDbGetMsgMux (KvaDbMessageHnd mh, KvaDbSignalHnd *sh) |
|
KvaDbStatus | kvaDbMsgDlcToBytes (KvaDbProtocolType prot, unsigned int dlc, unsigned int *numBytes) |
|
KvaDbStatus | kvaDbBytesToMsgDlc (KvaDbProtocolType prot, unsigned int numBytes, unsigned int *dlc) |
|
Add, delete and modify messages.
◆ kvaDbAddMsg()
◆ kvaDbBytesToMsgDlc()
Translates number of bytes to message dlc for a given protocol
- Parameters
-
[in] | prot | A protocol type |
[in] | numBytes | Number of bytes |
[out] | dlc | Raw message dlc |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetProtocol()
◆ kvaDbDeleteMsg()
Delete a message from a database.
- Parameters
-
[in] | dh | A database handle |
[in] | mh | A handle to the message that will be deleted |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbAddMsg()
- Examples:
- candb_sample.c.
◆ kvaDbGetFirstMsg()
◆ kvaDbGetMsgById()
Get a handle to a message with a specific identifier.
- Parameters
-
[in] | dh | A database handle |
[in] | id | The selected message identifier |
[out] | mh | A message handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetMsgByName()
- Examples:
- candb_sample.c.
◆ kvaDbGetMsgByName()
Get a handle to a message with a specific name.
- Parameters
-
[in] | dh | A databse handle |
[in] | msg_name | The message name to search for |
[out] | mh | A message handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetMsgById()
- Examples:
- candb_sample.c.
◆ kvaDbGetMsgComment()
Get the message comment.
- Parameters
-
[in] | mh | A message handle |
[out] | buf | The buffer that will hold the message comment |
[in] | buflen | The length of the buffer |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbSetMsgComment()
- Examples:
- candb_sample.c.
◆ kvaDbGetMsgDlc()
◆ kvaDbGetMsgFlags()
◆ kvaDbGetMsgId()
◆ kvaDbGetMsgIdEx()
Get the message identifier.
- Parameters
-
[in] | mh | A message handle |
[out] | id | The message identifier |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbSetMsgIdEx()
◆ kvaDbGetMsgMux()
Returns handle to a multiplexer signal of a given message
- Parameters
-
[in] | mh | A message handle |
[out] | sh | Multiplexer signal handle |
- Returns
- kvaDbOK (zero if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetMsgName()
◆ kvaDbGetMsgQualifiedName()
Get the qualified message name, which is the database name and the message name separated by a dot.
- Parameters
-
[in] | mh | A message handle |
[out] | buf | The buffer that will hold the qualified message name |
[in] | buflen | The length of the buffer |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetMsgName()
- Examples:
- candb_sample.c.
◆ kvaDbGetMsgSendNode()
◆ kvaDbGetNextMsg()
◆ kvaDbMsgDlcToBytes()
Translates message dlc to number of bytes for a given protocol
- Parameters
-
[in] | prot | A protocol type |
[in] | dlc | Raw message dlc |
[out] | numBytes | Number of bytes |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetProtocol()
◆ kvaDbSetMsgComment()
◆ kvaDbSetMsgDlc()
◆ kvaDbSetMsgFlags()
◆ kvaDbSetMsgId()
◆ kvaDbSetMsgIdEx()
Set the message identifier.
- Parameters
-
[in] | mh | A message handle |
[in] | id | The message identifier |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetMsgIdEx()
◆ kvaDbSetMsgName()
◆ kvaDbSetMsgSendNode()