EmSACAN_ReadParameter
Prototype
emsacan_result_t EmSACAN_ReadParameter(
emsacan_handle_t Handle,
emsacan_parameter_t Parameter,
unsigned int ChannelNumber,
uint8_t *Buffer,
int BufferSize,
int *pBytesRead );Description
Reads a device parameter (see emsacan_parameter_t).
Parameters
| Parameter | Direction | Type | Description |
|---|---|---|---|
Handle | in | emsacan_handle_t | Session handle from EmSACAN_Connect. |
Parameter | in | emsacan_parameter_t | Which parameter to read. |
ChannelNumber | in | unsigned int | Zero-based port index for port-specific parameters; ignored for |
Buffer | out | uint8_t | Destination for raw bytes. |
BufferSize | in | int | Maximum bytes to store in Buffer. |
pBytesRead | out | int | On success, number of bytes written to Buffer. |
Return value
EMSACAN_OK on success, or another emsacan_result_t code on failure.
Example
emsacan_channel_config_t cfg;
int bytes = 0;
emsacan_result_t rc = EmSACAN_ReadParameter(
handle, EMSACAN_PARAM_CHANNELCONFIG, 0,
(uint8_t *)&cfg, sizeof(cfg), &bytes);
if (rc == EMSACAN_OK && bytes >= (int)sizeof(cfg))
{ /* use cfg.nominal_kbps, cfg.termination, etc. */ }