Converter

Functions
KvlcStatus	kvlcGetErrorText (KvlcStatus error, char *buffer, unsigned int buffer_size)
KvlcStatus	kvlcGetVersion (unsigned int *major, unsigned int *minor, unsigned int *build)
KvlcStatus	kvlcCreateConverter (KvlcHandle *handle, const char *filename, int format)
KvlcStatus	kvlcDeleteConverter (KvlcHandle handle)
KvlcStatus	kvlcEventCount (KvlcHandle handle, unsigned int *count)
KvlcStatus	kvlcEventCountEx (KvlcHandle handle, int64 *count)
KvlcStatus	kvlcConvertEvent (KvlcHandle handle)
KvlcStatus	kvlcSetInputFile (KvlcHandle handle, const char *filename, int format)
KvlcStatus	kvlcNextInputFile (KvlcHandle handle, const char *filename)
KvlcStatus	kvlcIsOutputFilenameNew (KvlcHandle handle, int *updated)
KvlcStatus	kvlcGetOutputFilename (KvlcHandle handle, char *filename, int len)
KvlcStatus	kvlcGetWriterPropertyDefault (int format, unsigned int property, void *buf, unsigned int len)
KvlcStatus	kvlcSetProperty (KvlcHandle handle, unsigned int property, void *buf, unsigned int len)
KvlcStatus	kvlcGetProperty (KvlcHandle handle, unsigned int property, void *buf, unsigned int len)
KvlcStatus	kvlcIsOverrunActive (KvlcHandle handle, int *overrun)
KvlcStatus	kvlcResetOverrunActive (KvlcHandle handle)
KvlcStatus	kvlcIsDataTruncated (KvlcHandle handle, int *truncated)
KvlcStatus	kvlcResetDataTruncated (KvlcHandle handle)
KvlcStatus	kvlcAttachFile (KvlcHandle handle, const char *filename)
KvlcStatus	kvlcGetReaderPropertyDefault (int format, unsigned int property, void *buf, unsigned int len)
KvlcStatus	kvlcIsDlcMismatch (KvlcHandle handle, int *mismatch)
KvlcStatus	kvlcResetDlcMismatch (KvlcHandle handle)
KvlcStatus	kvlcGetDlcMismatchList (KvlcHandle handle, unsigned int *MsgIds, unsigned int *MsgDlc, unsigned int *MsgOccurance, unsigned int *length)

Detailed Description

Function Documentation

kvlcAttachFile()

KvlcStatus kvlcAttachFile	(	KvlcHandle	handle,
		const char *	filename
	)

C#

static Kvlclib.Status AttachFile(Handle hnd, String filename);

Attach a file to be included in the output file, e.g. used to add a database or a movie to the output.

Note

The output format must support the property KVLC_PROPERTY_ATTACHMENTS.

Parameters

[in]	handle	An open handle to a converter.
[out]	filename	File to be included in output, a pointer to a NULL terminated array of chars.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsPropertySupported()

kvlcConvertEvent()

KvlcStatus kvlcConvertEvent

(

KvlcHandle

handle

)

C#

static Kvlclib.Status ConvertEvent(Handle hnd);

Convert one event from input file and write it to output file.

Parameters

[in]

handle

An open handle to a converter.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

kvlcCreateConverter()

KvlcStatus kvlcCreateConverter	(	KvlcHandle *	handle,
		const char *	filename,
		int	format
	)

C#

static Kvlclib.Status CreateConverter(out Handle hnd, String filename, FileFormat format);

Create a new converter.

Parameters

[out]	handle	An open handle to a converter.
[in]	filename	Output filename, a pointer to a NULL terminated array of chars.
[in]	format	Output format, use FILE_FORMAT_xxx.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

Note

No more than 128 converter handles can be open at the same time.

See also

kvlcDeleteConverter()

kvlcDeleteConverter()

KvlcStatus kvlcDeleteConverter

(

KvlcHandle

handle

)

C#

static Kvlclib.Status DeleteConverter(Handle hnd);

Delete a converter and close all files.

Parameters

[in]

handle

An open handle to a converter.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcCreateConverter()

kvlcEventCount()

KvlcStatus kvlcEventCount	(	KvlcHandle	handle,
		unsigned int *	count
	)

C#

static Kvlclib.Status EventCount(Handle hnd, out Int32 count);

Deprecated:

Use kvlcEventCountEx instead.

Get the estimated number of remaining events in the input file. This can be useful for displaying progress during conversion.

Parameters

[in]	handle	An open handle to a converter.
[out]	count	The estimated number of remaining events in the input file.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

Note

if return value is kvlcERR_RESULT_TOO_BIG, use kvlcEventCountEx instead.

kvlcEventCountEx()

KvlcStatus kvlcEventCountEx	(	KvlcHandle	handle,
		int64 *	count
	)

C#

static Kvlclib.Status EventCountEx(Handle hnd, out Int64 count);

Get the estimated number of remaining events in the input file. This can be useful for displaying progress during conversion.

Parameters

[in]	handle	An open handle to a converter.
[out]	count	The estimated number of remaining events in the input file.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

kvlcGetDlcMismatchList()

KvlcStatus kvlcGetDlcMismatchList	(	KvlcHandle	handle,
		unsigned int *	MsgIds,
		unsigned int *	MsgDlc,
		unsigned int *	MsgOccurance,
		unsigned int *	length
	)

Return sets of mismatching msg id and dlc The length parameter is used to get the necessary length or to inform the API how long the supplied list is.

Parameters

[in]	handle	An open handle to a converter.
[out]	MsgIds	An array to hold the returned message ids
[out]	MsgDlc	An array to hold the returned message dlc
[out]	MsgOccurance	An array to hold the returned number of occurance of each mismatch
[in,out]	length	Use 0 in to get the necessary length of the arrays out

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsDlcMismatch(), kvlcResetDlcMismatch()

kvlcGetErrorText()

KvlcStatus kvlcGetErrorText	(	KvlcStatus	error,
		char *	buffer,
		unsigned int	buffer_size
	)

C#

static Kvlclib.Status GetErrorText(Status error, out String buf);

Convert a KvlcStatus error code to a text.

Parameters

[in]	error	The error code to convert.
[out]	buffer	Buffer to receive error text, a pointer to a NULL terminated array of chars.
[in]	buffer_size	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

kvlcGetOutputFilename()

KvlcStatus kvlcGetOutputFilename	(	KvlcHandle	handle,
		char *	filename,
		int	len
	)

C#

static Kvlclib.Status GetOutputFilename(Handle hnd, out String filename);

Get the filename of the current output file.

This function can be used in conjunction with kvlcIsOutputFilenameNew() to report current filename when splitting output into multiple files.

Parameters

[in]	handle	An open handle to a converter.
[out]	filename	Buffer to receive output filename, a pointer to a NULL terminated array of chars.
[in]	len	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsOutputFilenameNew()

kvlcGetProperty()

KvlcStatus kvlcGetProperty	(	KvlcHandle	handle,
		unsigned int	property,
		void *	buf,
		unsigned int	len
	)

Get a property value. The buffer pointer and length of the data type must match the property specified in PROPERTY_xxx.

C#

static Kvlclib.Status GetProperty(Handle hnd, Property property, out Char value);
static Kvlclib.Status GetProperty(Handle hnd, Property property, out Int32 value);
static Kvlclib.Status GetProperty(Handle hnd, Property property, out Int64 value);

Parameters

[in]	handle	An open handle to a converter.
[in]	property	Property, use PROPERTY_xxx.
[out]	buf	Buffer to receive property value.
[in]	len	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsPropertySupported(), kvlcSetProperty(), kvlcGetWriterPropertyDefault()

kvlcGetReaderPropertyDefault()

KvlcStatus kvlcGetReaderPropertyDefault	(	int	format,
		unsigned int	property,
		void *	buf,
		unsigned int	len
	)

C#

static Kvlclib.Status GetReaderPropertyDefault(FileFormat format, Property property, out Char value);
static Kvlclib.Status GetReaderPropertyDefault(FileFormat format, Property property, out Int32 value);
static Kvlclib.Status GetReaderPropertyDefault(FileFormat format, Property property, out Int64 value);

Get the default value for a property. The buffer pointer and length of the data type must match the property specified in PROPERTY_xxx, e.g.

time_int64 offset; kvlcGetReaderPropertyDefault(KVLC_PROPERTY_OFFSET, &offset, sizeof(offset));

Parameters

[in]	format	Output format, use FILE_FORMAT_xxx.
[in]	property	Property, use PROPERTY_xxx.
[out]	buf	Buffer to receive property value.
[in]	len	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcGetFirstReaderFormat(), kvlcIsPropertySupported(), kvlcGetProperty()

kvlcGetVersion()

KvlcStatus kvlcGetVersion	(	unsigned int *	major,
		unsigned int *	minor,
		unsigned int *	build
	)

C#

static Kvlclib.Status GetVersion(out Int32 major, out Int32 minor, out Int32 build);

Returns the version of the kvcnvlib DLL.

Parameters

[out]	major	Major version number.
[out]	minor	Minor version number.
[out]	build	Build version number.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

kvlcGetWriterPropertyDefault()

KvlcStatus kvlcGetWriterPropertyDefault	(	int	format,
		unsigned int	property,
		void *	buf,
		unsigned int	len
	)

C#

static Kvlclib.Status GetWriterPropertyDefault(FileFormat format, Property property, out Char value);
static Kvlclib.Status GetWriterPropertyDefault(FileFormat format, Property property, out Int32 value);
static Kvlclib.Status GetWriterPropertyDefault(FileFormat format, Property property, out Int64 value);

Get the default value for a property. The buffer pointer and length of the data type must match the property specified in PROPERTY_xxx, e.g.

time_int64 offset; kvlcGetWriterPropertyDefault(KVLC_PROPERTY_OFFSET, &offset, sizeof(offset));

Parameters

[in]	format	Output format, use FILE_FORMAT_xxx.
[in]	property	Property, use PROPERTY_xxx.
[out]	buf	Buffer to receive property value.
[in]	len	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcGetFirstWriterFormat(), kvlcIsPropertySupported(), kvlcGetProperty()

kvlcIsDataTruncated()

KvlcStatus kvlcIsDataTruncated	(	KvlcHandle	handle,
		int *	truncated
	)

C#

static Kvlclib.Status IsDataTruncated(Handle hnd, out Int32 truncated);

Get truncation status.

Truncation occurs when the selected output converter can't write the all bytes in a data frame to file. This can happen if CAN FD data is extracted to a format that only supports up to 8 data bytes, e.g. KVLC_FILE_FORMAT_KME40.

It can also happen if KVLC_PROPERTY_LIMIT_DATA_BYTES is set to limit the number of data bytes in output.

Parameters

[in]	handle	An open handle to a converter.
[out]	truncated	Not zero if data is truncated.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsOverrunActive(), kvlcResetDataTruncated()

kvlcIsDlcMismatch()

KvlcStatus kvlcIsDlcMismatch	(	KvlcHandle	handle,
		int *	mismatch
	)

C#

static Kvlclib.Status IsDlcMismatch(Handle hnd, out Int32 mismatch);

Return dlc mismatch status (i.e. CAN id is found in db but it has mismatching dlc)

Parameters

[in]	handle	An open handle to a converter.
[in]	mismatch	Not zero if a mismatch occured

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcResetDlcMismatch(), kvlcGetDlcMismatchList()

kvlcIsOutputFilenameNew()

KvlcStatus kvlcIsOutputFilenameNew	(	KvlcHandle	handle,
		int *	updated
	)

C#

static Kvlclib.Status IsOutputFilenameNew(Handle hnd, out Int32 updated);

Check if the converter has created a new file. It is only true once after a new file has been created. Used when splitting output into multiple files.

Parameters

[in]	handle	An open handle to a converter.
[out]	updated	Not zero if a new file has been created.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcGetOutputFilename()

kvlcIsOverrunActive()

KvlcStatus kvlcIsOverrunActive	(	KvlcHandle	handle,
		int *	overrun
	)

C#

static Kvlclib.Status IsOverrunActive(Handle hnd, out Int32 overrun);

Get overrun status.

Overruns can occur during logging with a Memorator if the bus load exceeds the logging capacity. This is very unusual, but can occur if a Memorator runs complex scripts and triggers.

Parameters

[in]	handle	An open handle to a converter.
[out]	overrun	Not zero if an overrun occurred.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsDataTruncated()

kvlcNextInputFile()

KvlcStatus kvlcNextInputFile	(	KvlcHandle	handle,
		const char *	filename
	)

C#

static Kvlclib.Status NextInputFile(Handle hnd, String filename);

Select next input file.

Note

It is the responsibility of the caller to arrange multiple files in correct time stamp order. Overlapping time stamps are not handled.

Parameters

[in]	handle	An open handle to a converter.
[in]	filename	Next input filename, a pointer to a NULL terminated array of chars.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcSetInputFile()

kvlcResetDataTruncated()

KvlcStatus kvlcResetDataTruncated

(

KvlcHandle

handle

)

C#

static Kvlclib.Status ResetDataTruncated(Handle hnd);

Reset truncation status.

Parameters

[in]

handle

An open handle to a converter.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsDataTruncated()

kvlcResetDlcMismatch()

KvlcStatus kvlcResetDlcMismatch

(

KvlcHandle

handle

)

C#

static Kvlclib.Status ResetDlcMismatch(Handle hnd);

Reset dlc mismatch status

Parameters

[in]

handle

An open handle to a converter.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsDlcMismatch(), kvlcGetDlcMismatchList()

kvlcResetOverrunActive()

KvlcStatus kvlcResetOverrunActive

(

KvlcHandle

handle

)

C#

static Kvlclib.Status ResetOverrunActive(Handle hnd);

Reset overrun status.

Parameters

[in]

handle

An open handle to a converter.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsOverrunActive()

kvlcSetInputFile()

KvlcStatus kvlcSetInputFile	(	KvlcHandle	handle,
		const char *	filename,
		int	format
	)

C#

static Kvlclib.Status SetInputFile(Handle hnd, String filename, FileFormat format);

Select input file.

Parameters

[in]	handle	An open handle to a converter.
[in]	filename	Input filename, a pointer to a NULL terminated array of chars.
[in]	format	Input format, use FILE_FORMAT_xxx.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcNextInputFile()

kvlcSetProperty()

KvlcStatus kvlcSetProperty	(	KvlcHandle	handle,
		unsigned int	property,
		void *	buf,
		unsigned int	len
	)

C#

static Kvlclib.Status SetProperty(Handle hnd, Property property, Char value);
static Kvlclib.Status SetProperty(Handle hnd, Property property, Int32 value);
static Kvlclib.Status SetProperty(Handle hnd, Property property, Int64 value);

Set a property value. The buffer pointer and length of the data type must match the property specified in PROPERTY_xxx.

Parameters

[in]	handle	An open handle to a converter.
[in]	property	Property, use PROPERTY_xxx.
[in]	buf	Buffer containing property value.
[in]	len	Buffer size in bytes.

Returns

kvlcOK (zero) if success

kvlcERR_xxx (negative) if failure

See also

kvlcIsPropertySupported(), kvlcGetWriterPropertyDefault(), kvlcGetProperty()