Can_returnValues
[CanDefines]

Modules
	Can_frameFakes
	CanFunctions
Enumerations
enum	{   S_SUCCESS = 0, S_PENDING, S_ERR_QUEUE_IS_EMPTY, S_ERR_QUEUE_IS_FULL,   S_ERR_TX_NOT_POSSIBLE, S_ERR_TWICE_REGISTER, S_ERR_INVALID_CHAN_INDEX, S_ERR_INVALID_ACCESS,   S_ERR_PORT_IS_OFFLINE, S_ERR_CHAN_IS_ONLINE, S_ERR_INVALID_PORT, S_ERR_HW_NOT_READY,   S_ERR_CMD_TIMEOUT, S_ERR_HW_NOT_PRESENT, S_ERR_NOTIFY_ALREADY_ACTIVE, S_ERR_NO_RESOURCES,   S_ERR_CANNOT_OPEN_DRIVER, S_ERR_NOT_IMPLEMENTED, S_ERR_INV_HANDLE, S_ERR_INVARG1,   S_ERR_INVARG2, S_ERR_INVARG3, S_ERR_INVARGS, S_ERR_OOB,   S_ERR_UNKNOWN, S__MAX }
Variables
uchar   can20bframe::srr
	SRR bit.
uchar   can20bframe::ide
	IDE bit.
ulong   can20bframe::identifier18bit
	18 bit arbitration id of a CAN 2.0 B frame
uchar   can20bframe::rtr
	The RTR bit.
struct {
ushort   identifier11bit
	11 bit arbitration id of a CAN 2.0 frame
uchar   can20bframe::srr
	SRR bit.
uchar   can20bframe::ide
	IDE bit.
ulong   can20bframe::identifier18bit
	18 bit arbitration id of a CAN 2.0 B frame
uchar   can20bframe::rtr
	The RTR bit.
}	can20bframe::arbitration
	The arbitration structure.
struct {
ushort   r1
	Reserved bit 1.
ushort   r0
	Reserved bit 0.
ushort   dlc
	The 4 bit length of the payload.
}	can20bframe::control
	The control structure.
uchar	can20bframe::data [8]
	The data payload.
uchar   can20bframe::delimeter
	Single bit at the end of the CRC.
struct {
uint   sequence
	The 15 bit CRC sequence.
uchar   can20bframe::delimeter
	Single bit at the end of the CRC.
}	can20bframe::crc
	The CRC structure.
struct {
uchar   slot
	The single bit acknowledgement slot.
uchar   can20bframe::delimeter
	The single bit acknowledgement delimeter.
}	can20bframe::ack
	The acknowledgement structure.
uchar	can20bframe::eof
	7 recessive bits at the end of the frame
uchar   can20bframe::msgtype
	DATA/REMOTE/ERROR/Interframe Space.
ushort   can20bframe::isfake
	What part of the frame was faked.
ulong   can20bframe::txid
	Internal notion of the transmission ID.
struct {
struct {
unsigned __int64   ts_sec
	CAN latched time in seconds of a frame.
unsigned __int64   ts_nsec
	CAN latched time in nanoseconds of a frame.
}   ts
	The timestamp structure.
uchar   can20bframe::msgtype
	DATA/REMOTE/ERROR/Interframe Space.
ushort   can20bframe::isfake
	What part of the frame was faked.
ulong   can20bframe::txid
	Internal notion of the transmission ID.
}	can20bframe::oob
	The out of bounds structure.

---

Enumeration Type Documentation

anonymous enum

Enumerator: S_SUCCESS  Everything is ok, move on. S_PENDING  If the packet has been read without problems. S_ERR_QUEUE_IS_EMPTY  The Queue is empty, no need to panic. S_ERR_QUEUE_IS_FULL  The Queue is full, try a can_boardread. S_ERR_TX_NOT_POSSIBLE  Transmission is currently not possible, perhaps try can_channelopen. S_ERR_TWICE_REGISTER  If the packet has been read without problems. S_ERR_INVALID_CHAN_INDEX  If the packet has been read without problems. S_ERR_INVALID_ACCESS  If the packet has been read without problems. S_ERR_PORT_IS_OFFLINE  If the packet has been read without problems. S_ERR_CHAN_IS_ONLINE  You tried to put online a channel that was already online. S_ERR_INVALID_PORT  If the packet has been read without problems. S_ERR_HW_NOT_READY  Error, please try again later. S_ERR_CMD_TIMEOUT  If the packet has been read without problems. S_ERR_HW_NOT_PRESENT  If the packet has been read without problems. S_ERR_NOTIFY_ALREADY_ACTIVE  If the packet has been read without problems. S_ERR_NO_RESOURCES  If the packet has been read without problems. S_ERR_CANNOT_OPEN_DRIVER  This is problematic... S_ERR_NOT_IMPLEMENTED  If the packet has been read without problems. S_ERR_INV_HANDLE  You passed an invalid handle. S_ERR_INVARG1  Check the first argument passed - the function didn't like it. S_ERR_INVARG2  Check the second argument passed - the function didn't like it. S_ERR_INVARG3  Check the third argument passed - the function didn't like it. S_ERR_INVARGS  Check the arguments passed - the function didn't like it. S_ERR_OOB  If the packet has been read without problems. S_ERR_UNKNOWN  If the packet has been read without problems. S__MAX  Definition at line 200 of file canapi.h.

---

Variable Documentation

struct { ... } can20bframe::ack [inherited]

The acknowledgement structure. Referenced by can_can2raw(), and vector_canboardread().

struct { ... } can20bframe::arbitration [inherited]

The arbitration structure. Referenced by can_can2raw(), can_getfield(), vector_canboardread(), and vector_canboardwrite().

struct { ... } can20bframe::control [inherited]

The control structure. Referenced by can_can2raw(), vector_canboardread(), and vector_canboardwrite().

struct { ... } can20bframe::crc [inherited]

The CRC structure. Referenced by can_can2raw(), and vector_canboardread().

uchar can20bframe::data[8] [inherited]

The data payload. Definition at line 108 of file canapi.h. Referenced by can_can2raw(), vector_canboardread(), and vector_canboardwrite().

uchar { ... } ::delimeter [inherited]

The single bit acknowledgement delimeter. Definition at line 116 of file canapi.h.

uchar { ... } ::delimeter [inherited]

Single bit at the end of the CRC. Definition at line 112 of file canapi.h.

uchar can20bframe::delimeter [inherited]

The single bit acknowledgement delimeter. Definition at line 112 of file canapi.h.

ushort { ... } ::dlc [inherited]

The 4 bit length of the payload. Definition at line 103 of file canapi.h.

uchar can20bframe::eof [inherited]

7 recessive bits at the end of the frame Definition at line 120 of file canapi.h. Referenced by can_can2raw(), and vector_canboardread().

uchar { ... } ::ide [inherited]

IDE bit. Definition at line 96 of file canapi.h.

uchar can20bframe::ide [inherited]

IDE bit. Definition at line 96 of file canapi.h.

ushort { ... } ::identifier11bit [inherited]

11 bit arbitration id of a CAN 2.0 frame Definition at line 95 of file canapi.h.

ulong { ... } ::identifier18bit [inherited]

18 bit arbitration id of a CAN 2.0 B frame Definition at line 98 of file canapi.h.

ulong can20bframe::identifier18bit [inherited]

18 bit arbitration id of a CAN 2.0 B frame Definition at line 98 of file canapi.h.

ushort { ... } ::isfake [inherited]

What part of the frame was faked. Definition at line 132 of file canapi.h.

ushort can20bframe::isfake [inherited]

What part of the frame was faked. Definition at line 132 of file canapi.h.

uchar { ... } ::msgtype [inherited]

DATA/REMOTE/ERROR/Interframe Space. Definition at line 129 of file canapi.h.

uchar can20bframe::msgtype [inherited]

DATA/REMOTE/ERROR/Interframe Space. Definition at line 129 of file canapi.h.

struct { ... } can20bframe::oob [inherited]

The out of bounds structure. Referenced by vector_canboardread().

ushort { ... } ::r0 [inherited]

Reserved bit 0. Definition at line 103 of file canapi.h.

ushort { ... } ::r1 [inherited]

Reserved bit 1. Definition at line 103 of file canapi.h.

uchar { ... } ::rtr [inherited]

The RTR bit. Definition at line 99 of file canapi.h.

uchar can20bframe::rtr [inherited]

The RTR bit. Definition at line 99 of file canapi.h.

uint { ... } ::sequence [inherited]

The 15 bit CRC sequence. Definition at line 111 of file canapi.h.

uchar { ... } ::slot [inherited]

The single bit acknowledgement slot. Definition at line 116 of file canapi.h.

uchar { ... } ::srr [inherited]

SRR bit. Definition at line 96 of file canapi.h.

uchar can20bframe::srr [inherited]

SRR bit. Definition at line 96 of file canapi.h.

struct { ... } ::ts [inherited]

The timestamp structure.

unsigned { ... } ::ts_nsec [inherited]

CAN latched time in nanoseconds of a frame. Definition at line 125 of file canapi.h.

unsigned { ... } ::ts_sec [inherited]

CAN latched time in seconds of a frame. Definition at line 125 of file canapi.h.

ulong { ... } ::txid [inherited]

Internal notion of the transmission ID. Definition at line 135 of file canapi.h.

ulong can20bframe::txid [inherited]

Internal notion of the transmission ID. Definition at line 135 of file canapi.h.

---