Hatteland Display HT B22 (Fanless) - Manual (Page 24)

DOC101357-1_ - rev 2 – 2013-09-23 - Created by:6644
Page 24 of 25
Hatteland Display AS, Åmsosen, N-5578 Nedre Vats, Norway
Tel: (+47) 4814 2200 - [email protected] - www.hatteland-display.com
HD CAN Module Programmer’s Guide (Windows)
All intellectual properties belongs to Hatteland Display AS
o)
J2534_ERROR_CODE J2534::PassThruWriteMsg
s
( unsigned long ChannelID,
PASSTHRU_MS
G
* pMsg,
unsigned long
* pNumMsgs
,
unsigned long Timeout
)
This function is used to send messages. The messages are placed in the buffer and sent
in the order they were received. Only one message per protocol can be in transmission at
a time (with one exception - see PassThruStartPeriodicMsg). If the function is successful,
a value of STATUS_NOERROR is returned. Specifying a non-zero Timeout performs a
blocking write. When using blocking writes, this function does not return until all
messages are successfully sent on the vehicle network, or the timeout has expired or an
error occurs.
Parameters:
[in] ChannelID The channel ID assigned by the PassThruConnect function.
[in] *pMsg Pointer to message structure(s).
[in] *pNumMsgs Pointer to location where number of messages to write is
specified.
[in] Timeout Write timeout (in milliseconds). When a value of 0 is
specified, the function queues as many of the specified
messages as possible and returns immediately. When a value
greater than 0 is specified, the function will block until the
Timeout has expired, an error has occurred, or the desired
number of messages have been transmitted on the vehicle
network. Even if the device can buffer only one packet at a
time, this function shall be able to send an arbitrary number
of packets if a Timeout value is supplied. Since the function
returns early if all the messages have been sent, there is
normally no penalty for having a large timeout (several
seconds). If the number of messages requested have been
written, the function shall not return ERR_TIMEOUT, even if
the timeout value is zero.
[out] *pNumMsgs On return will contain the actual number of messages that
were transmitted (when Timeout is nonzero) or placed in the
transmit queue (when Timeout is zero).
Returns:
Status, see function return codes in hdj2534.h .