Used for auto transmit and auto response messages. More...

Functions
canStatus	canObjBufFreeAll (const int hnd)

canStatus	canObjBufAllocate (const int hnd, int type)

canStatus	canObjBufFree (const int hnd, int idx)

canStatus	canObjBufWrite (const int hnd, int idx, int id, void *msg, unsigned int dlc, unsigned int flags)

canStatus	canObjBufSetFilter (const int hnd, int idx, unsigned int code, unsigned int mask)

canStatus	canObjBufSetFlags (const int hnd, int idx, unsigned int flags)

canStatus	canObjBufSetPeriod (const int hnd, int idx, unsigned int period)

canStatus	canObjBufSetMsgCount (const int hnd, int idx, unsigned int count)

canStatus	canObjBufEnable (const int hnd, int idx)

canStatus	canObjBufDisable (const int hnd, int idx)

canStatus	canObjBufSendBurst (const int hnd, int idx, unsigned int burstlen)

Detailed Description

Used for auto transmit and auto response messages.

Function Documentation

◆ canObjBufAllocate()

canStatus canObjBufAllocate	(	const int	hnd,
		int	type
	)

C#: static Canlib.canStatus canObjBufAllocate(CanHandle hnd, Int32 type);

Delphi: function canObjBufAllocate(handle: canHandle; tp: Integer): canStatus;

Allocates an object buffer associated with a handle to a CAN circuit.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	type	The type of the buffer. Must be one of canOBJBUF_TYPE_xxx

Returns: A buffer index (zero or positive) if success.; canERR_xxx (negative) if failure

See also: Object Buffers; canObjBufFree(), canObjBufFreeAll()

◆ canObjBufDisable()

canStatus canObjBufDisable	(	const int	hnd,
		int	idx
	)

C#: static Canlib.canStatus canObjBufDisable(CanHandle hnd, Int32 idx);

Delphi: function canObjBufDisable(handle: canHandle; idx: Integer): canStatus;

Disables the object buffer with the specified index.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The index of the buffer.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers; canObjBufEnable()

◆ canObjBufEnable()

canStatus canObjBufEnable	(	const int	hnd,
		int	idx
	)

C#: static Canlib.canStatus canObjBufEnable(CanHandle hnd, Int32 idx);

Delphi: function canObjBufEnable(handle: canHandle; idx: Integer): canStatus;

Enables the object buffer with the specified index.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The index of the object buffer to enable.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers; canObjBufDisable()

◆ canObjBufFree()

canStatus canObjBufFree	(	const int	hnd,
		int	idx
	)

C#: static Canlib.canStatus canObjBufFree(CanHandle hnd, Int32 idx);

Delphi: function canObjBufFree(handle: canHandle; idx: Integer): canStatus;

Deallocates the object buffer with the specified index. The buffer can not be referenced after this operation.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The object buffer to deallocate.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers; canObjBufFreeAll(), canObjBufAllocate(),

◆ canObjBufFreeAll()

canStatus canObjBufFreeAll ( const int hnd )

C#: static Canlib.canStatus canObjBufFreeAll(CanHandle hnd);

Delphi: function canObjBufFreeAll(handle: canHandle): canStatus;

Deallocates all object buffers on the specified handle. The buffers cannot be referenced after this operation.

Parameters

[in] hnd An open handle to a CAN circuit.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers; canObjBufFree(), canObjBufAllocate()

◆ canObjBufSendBurst()

canStatus canObjBufSendBurst	(	const int	hnd,
		int	idx,
		unsigned int	burstlen
	)

C#: static Canlib.canStatus canObjBufSendBurst(CanHandle hnd, Int32 idx, Int32 burstlen);

Delphi: function canObjBufSendBurst(handle: canHandle; idx: Integer; burstLen: Cardinal): canStatus;

The canObjBufSendBurst function sends a burst of CAN messages. You have to set up an object buffer first with the message to send. The messages will be sent as fast as possible from the hardware.

This function is intended for certain diagnostic applications.

Parameters

[in]	hnd	An open handle to a CAN channel.
[in]	idx	The index of a CAN object buffer.
[in]	burstlen	The number of messages to send.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

◆ canObjBufSetFilter()

canStatus canObjBufSetFilter	(	const int	hnd,
		int	idx,
		unsigned int	code,
		unsigned int	mask
	)

C#: static Canlib.canStatus canObjBufSetFilter(CanHandle hnd, Int32 idx, Int32 code, Int32 mask);

Delphi: function canObjBufSetFilter(handle: canHandle; idx: Integer; code, mask: Cardinal): canStatus;

Defines a message reception filter on the specified object buffer. Messages not matching the filter are discarded.

Note: For an auto response buffer, set the code and mask that together define the identifier(s) that trigger(s) the automatic response.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The index of the object buffer on which the filter is to be set.
[in]	code	The acceptance code in the filter.
[in]	mask	The acceptance mask in the filter.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

◆ canObjBufSetFlags()

canStatus canObjBufSetFlags	(	const int	hnd,
		int	idx,
		unsigned int	flags
	)

C#: static Canlib.canStatus canObjBufSetFlags(CanHandle hnd, Int32 idx, Int32 flags);

Delphi: function canObjBufSetFlags(handle: canHandle; idx: Integer; flags: Cardinal): canStatus;

Sets object buffer flags on a specified object buffer.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The buffer on which the flags are to be set.
[in]	flags	Specifies a combination of zero or more of the canOBJBUF_AUTO_RESPONSE_xxx flag values

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

◆ canObjBufSetMsgCount()

canStatus canObjBufSetMsgCount	(	const int	hnd,
		int	idx,
		unsigned int	count
	)

C#: static Canlib.canStatus canObjBufSetMsgCount(CanHandle hnd, Int32 idx, Int32 count);

Delphi: function canObjBufSetMsgCount(handle: canHandle; idx: Integer; count: Cardinal): canStatus;

The canObjBufSetMsgCount function sets the message count for an auto transmit object buffer.

Parameters

[in]	hnd	An open handle to a CAN channel.
[in]	idx	The index of a CAN object buffer.
[in]	count	The message count.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

◆ canObjBufSetPeriod()

canStatus canObjBufSetPeriod	(	const int	hnd,
		int	idx,
		unsigned int	period
	)

C#: static Canlib.canStatus canObjBufSetPeriod(CanHandle hnd, Int32 idx, Int32 period);

Delphi: function canObjBufSetPeriod(handle: canHandle; idx: Integer; period: Cardinal): canStatus;

The canObjBufSetPeriod function sets the transmission period for an auto transmission object buffer.

Parameters

[in]	hnd	An open handle to a CAN channel.
[in]	idx	The index of a CAN object buffer.
[in]	period	The transmission interval, in microseconds.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

◆ canObjBufWrite()

canStatus canObjBufWrite	(	const int	hnd,
		int	idx,
		int	id,
		void *	msg,
		unsigned int	dlc,
		unsigned int	flags
	)

C#: static Canlib.canStatus canObjBufWrite(CanHandle hnd, Int32 idx, Int32 id, Byte[] msg, Int32 dlc, Int32 flags);

Delphi: function canObjBufWrite(handle: canHandle; idx, id: Integer; var msg; dlc, flags: cardinal): canStatus;

Defines the contents of a specific object buffer.

Parameters

[in]	hnd	An open handle to a CAN circuit.
[in]	idx	The index of the object buffer whose contents is to be defined.
[in]	id	The CAN identifier of the message.
[in]	msg	Points to the contents of the message.
[in]	dlc	The length of the message in bytes. For Classic CAN dlc can be at most 8, unless canOPEN_ACCEPT_LARGE_DLC is used. For CAN FD dlc can be one of the following 0-8, 12, 16, 20, 24, 32, 48, 64.
[in]	flags	Message flags; a combination of the canMSG_xxx flags.

Returns: canOK (zero) if success; canERR_xxx (negative) if failure

See also: Object Buffers

Functions

Detailed Description

Function Documentation

◆ canObjBufAllocate()

◆ canObjBufDisable()

◆ canObjBufEnable()

◆ canObjBufFree()

◆ canObjBufFreeAll()

◆ canObjBufSendBurst()

◆ canObjBufSetFilter()

◆ canObjBufSetFlags()

◆ canObjBufSetMsgCount()

◆ canObjBufSetPeriod()

◆ canObjBufWrite()