LIN Schedule tables

Access LIN schedule tables. More...

Functions
KvaDbStatus	kvaDbGetFirstScheduleTable (KvaDbHnd dh, KvaDbScheduleTableHnd *th)
KvaDbStatus	kvaDbGetNextScheduleTable (KvaDbHnd dh, KvaDbScheduleTableHnd *th)
KvaDbStatus	kvaDbGetScheduleTableByName (KvaDbHnd dh, const char *schedule_table_name, KvaDbScheduleTableHnd *th)
KvaDbStatus	kvaDbGetScheduleTableName (KvaDbScheduleTableHnd th, char *buf, size_t buflen)
KvaDbStatus	kvaDbGetScheduleTableQualifiedName (KvaDbScheduleTableHnd th, char *buf, size_t buflen)
KvaDbStatus	kvaDbGetFirstScheduleTableEntry (KvaDbScheduleTableHnd th, KvaDbScheduleTableEntryHnd *eh)
KvaDbStatus	kvaDbGetNextScheduleTableEntry (KvaDbScheduleTableHnd th, KvaDbScheduleTableEntryHnd *eh)
KvaDbStatus	kvaDbGetScheduleTableEntryMsg (KvaDbScheduleTableEntryHnd eh, KvaDbMessageHnd *mh)
KvaDbStatus	kvaDbGetScheduleTableEntryDelay (KvaDbScheduleTableEntryHnd eh, double *delay)

Detailed Description

Access LIN schedule tables.

Function Documentation

kvaDbGetFirstScheduleTable()

KvaDbStatus kvaDbGetFirstScheduleTable	(	KvaDbHnd	dh,
		KvaDbScheduleTableHnd *	th
	)

Get the first LIN schedule table in a database.

Parameters

[in]	dh	A handle to a database
[out]	th	A handle to the first schedule table

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetNextScheduleTable()

kvaDbGetFirstScheduleTableEntry()

KvaDbStatus kvaDbGetFirstScheduleTableEntry	(	KvaDbScheduleTableHnd	th,
		KvaDbScheduleTableEntryHnd *	eh
	)

Get the first entry in a LIN schedule table.

Parameters

[in]	th	A schedule table handle
[out]	eh	A handle to the first schedule table entry

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetNextScheduleTableEntry()

kvaDbGetNextScheduleTable()

KvaDbStatus kvaDbGetNextScheduleTable	(	KvaDbHnd	dh,
		KvaDbScheduleTableHnd *	th
	)

Get a handle to the next LIN schedule table in a database. Should be called after kvaDbGetFirstScheduleTable().

Parameters

[in]	dh	A database handle
[out]	th	A schedule table handle

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetFirstScheduleTable()

kvaDbGetNextScheduleTableEntry()

KvaDbStatus kvaDbGetNextScheduleTableEntry	(	KvaDbScheduleTableHnd	th,
		KvaDbScheduleTableEntryHnd *	eh
	)

Get the next entry in a LIN schedule table. Should be called after kvaDbGetFirstScheduleTableEntry().

Parameters

[in]	th	A schedule table handle
[out]	eh	A handle to the next schedule table entry

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetFirstScheduleTableEntry

kvaDbGetScheduleTableByName()

KvaDbStatus kvaDbGetScheduleTableByName	(	KvaDbHnd	dh,
		const char *	schedule_table_name,
		KvaDbScheduleTableHnd *	th
	)

Get a handle to a LIN schedule table with a specific name.

Parameters

[in]	dh	A database handle
[in]	schedule_table_name	The schedule table name to search for
[out]	th	A schedule table handle

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

kvaDbGetScheduleTableEntryDelay()

KvaDbStatus kvaDbGetScheduleTableEntryDelay	(	KvaDbScheduleTableEntryHnd	eh,
		double *	delay
	)

Get LIN schedule table entry delay in milliseconds. The delay before the message is sent after the previous message in the schedule table has been sent.

Parameters

[in]	eh	A schedule table entry handle
[out]	delay	The delay in milliseconds

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetFirstScheduleTableEntry

kvaDbGetScheduleTableEntryMsg()

KvaDbStatus kvaDbGetScheduleTableEntryMsg	(	KvaDbScheduleTableEntryHnd	eh,
		KvaDbMessageHnd *	mh
	)

Get message for a LIN schedule table entry

Parameters

[in]	eh	A schedule table entry handle
[out]	mh	A message handle

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetFirstScheduleTableEntry

kvaDbGetScheduleTableName()

KvaDbStatus kvaDbGetScheduleTableName	(	KvaDbScheduleTableHnd	th,
		char *	buf,
		size_t	buflen
	)

Get the name of a schedule table as a null-terminated string. A truncated string will be returned if buf is too small and status will be kvaDbOK.

Parameters

[in]	th	A schedule table handle
[out]	buf	The buffer that will hold the schedule table name
[in]	buflen	The length of the buffer.

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetScheduleTableQualifiedName()

kvaDbGetScheduleTableQualifiedName()

KvaDbStatus kvaDbGetScheduleTableQualifiedName	(	KvaDbScheduleTableHnd	th,
		char *	buf,
		size_t	buflen
	)

Get the qualified schedule table name, which is the database name and the schedule table name separated by a dot, as a null-terminated string. An empty string will be returned if buf is too small and status will be kvaDbOK.

Parameters

[in]	th	A schedule table handle
[out]	buf	The buffer that will hold the qualified schedule table name
[in]	buflen	The length of the buffer

Returns

kvaDbOK (zero) if success

kvaDbErr_xxx (negative) if failure

See also

kvaDbGetScheduleTableName()