Parameter Value Definitions

Defines the possible parameters for configuring and retrieving PCAN's environment values with the methods SetValue and GetValue.

Activation

Type

Identifier

Value

Description

Int32

PCAN_PARAMETER_OFF

0

The PCAN parameter is not set (inactive).

Int32

PCAN_PARAMETER_OFF

1

The PCAN parameter is set (active).

Filter

Type

Identifier

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

Type

Identifier

Value

Description

Int32

PCAN_CHANNEL_UNAVAILABLE

0

The PCAN Channel handle i.e. its associated hardware is not available.

Int32

PCAN_CHANNEL_AVAILABLE

1

The PCAN Channel handle is valid to connect/initialize. Furthermore, for plug-and-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.

Log-Configuration

Type

Identifier

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 Write / WriteFD methods.

Int32

LOG_FUNCTION_READ

0x10

Logs the CAN messages received with the Read / ReadFD methods.

Int32

LOG_FUNCTION_ALL

0xFFFF

Logs all possible information within the PCAN-Basic API functions.

Trace-Configuration

Type

Identifier

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).

Features

Type

Identifier

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).

Int32

FEATURE_IO_CAPABLE

4

The PCAN Channel represents a device that supports the configuration of digital and/or analogue IOs (input/output) for using with electronic circuits.

Service-Status

Type

Identifier

Value

Description

Int32

SERVICE_STATUS_STOPPED

1

The service is not running.

Int32

SERVICE_STATUS_RUNNING

4

The service is running.

Channel-Direction

Type

Identifier

Value

Description

Int32

LAN_DIRECTION_READ

0x01

The PCAN Channel is limited to incoming communication only.

Int32

LAN_DIRECTION_WRITE

0x02

The PCAN Channel is limited to outgoing communication only.

Int32

LAN_DIRECTION_READ_WRITE

LAN_DIRECTION_READ

OR

LAN_DIRECTION_WRITE

The PCAN Channel communication is bidirectional.

Other Constants

Type

Identifier

Value

Description

Int32

MAX_LENGTH_HARDWARE_NAME

33

Maximum length of the name of a device: 32 characters + terminator.

Int32

MAX_LENGTH_VERSION_STRING

256

Maximum length of a version string: 255 characters + terminator.

Remarks

These values are declared as object fields in an object oriented environment (Delphi, .NET Framework) and declared as #define's in C++ (plain API).

Important: For more information about each TPCANParameter value, please refer to the companion PDF documentation PCAN-Parameter_Documentation.pdf.

See Also