|
PCAN-Basic Documentation
|
 |
   |
Defines the possible values for setting and getting PCAN's environment information with the functions CAN_SetValue and CAN_GetValue.
Activation values:
|
|
Type |
Constant |
Value |
Description |
 |
Int32 |
PCAN_PARAMETER_OFF |
0 |
The PCAN parameter is not set (inactive). |
|
|
Int32 |
PCAN_PARAMETER_ON |
1 |
The PCAN parameter is set (active). |
Filter values:
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
PCAN_FILTER_CLOSE |
0 |
The PCAN filter is closed. No messages will be received. |
|
|
Int32 |
PCAN_FILTER_OPEN |
1 |
The PCAN filter is fully opened. All messages will be received. |
|
|
Int32 |
PCAN_FILTER_CUSTOM |
2 |
The PCAN filter is custom configured. Only registered messages will be received. |
Channel Availability values:
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
PCAN_CHANNEL_UNAVAILABLE |
0 |
The PCAN-Channel handle is illegal, or its associated hardware is not available. |
|
|
Int32 |
PCAN_CHANNEL_AVAILABLE |
1 |
The PCAN-Channel handle is valid to connect/initialize. Furthermore, for plug&play hardware, this means that the hardware is plugged-in. |
|
|
Int32 |
PCAN_CHANNEL_OCCUPIED |
2 |
The PCAN-Channel handle is valid, and is currently being used. |
|
|
Int32 |
PCAN_CHANNEL_PCANVIEW |
PCAN_CHANNEL_AVAILABLE Or PCAN_CHANNEL_OCCUPIED |
The PCAN-Channel handle is currently being used by a PCAN-View application and is valid to connect. |
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
LOG_FUNCTION_DEFAULT |
0x00 |
Logs system exceptions and errors. Custom log texts are also included. |
|
|
Int32 |
LOG_FUNCTION_ENTRY |
0x01 |
Logs the entries to the PCAN-Basic API functions. |
|
|
Int32 |
LOG_FUNCTION_PARAMETERS |
0x02 |
Logs the parameters passed to the PCAN-Basic API functions. |
|
|
Int32 |
LOG_FUNCTION_LEAVE |
0x04 |
Logs the exits from the PCAN-Basic API functions. |
|
|
Int32 |
LOG_FUNCTION_WRITE |
0x08 |
Logs the CAN messages passed to the CAN_Write function. |
|
|
Int32 |
LOG_FUNCTION_READ |
0x10 |
Logs the CAN messages received within the CAN_Read function. |
|
|
Int32 |
LOG_FUNCTION_ALL |
0xFFFF |
Logs all possible information within the PCAN-Basic API functions. |
*These values can be combined using the bitwise inclusive OR operator
Trace-Configuration values*:
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
TRACE_FILE_SINGLE |
0x00 |
Stores messages in a single file until the configured file size is reached. |
|
|
Int32 |
TRACE_FILE_SEGMENTED |
0x01 |
Stores messages distributed in several files. |
|
|
Int32 |
TRACE_FILE_DATE |
0x02 |
Includes date information into the name of the trace file. |
|
|
Int32 |
TRACE_FILE_TIME |
0x04 |
Includes the time information into the name of the trace file. |
|
|
Int32 |
TRACE_FILE_OVERWRITE |
0x08 |
Forces the overwriting of available traces (same name). |
*These values can be combined using the bitwise inclusive OR operator
Feature values*:
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
FEATURE_FD_CAPABLE |
1 |
The PCAN Channel represents a device that supports flexible data rate (CAN-FD). |
|
|
Int32 |
FEATURE_DELAY_CAPABLE |
2 |
The PCAN Channel represents a device that supports the configuration of a delay between sending frames (FPGA devices only) |
*These values can be combined using the bitwise inclusive OR operator
Service-Status values:
|
|
Type |
Constant |
Value |
Description |
|
|
Int32 |
SERIVCE_STATUS_STOPPED |
1 |
The service is not running. |
|
|
Int32 |
SERVICE_STATUS_RUNNING |
4 |
The service is running. |
RemarksThese definitions are constants values in an object oriented environment (Delphi, .NET Framework) and declared as defines in C++ (plain API).
Python:
The definitions of these values have the following form: TPCANParameter(value) where value is the value contained in the column with the same name. e.g. LOG_FUNCTION_ENTRY is defined as TPCANParameter(0x01).
|
Copyright © 2017. PEAK-System Technik GmbH. All rights reserved.
|
|
Send feedback to this documentation
|