FB_CollisionHandlerTSeries - GetOptionalParameters (Method)

Overview

Type:

Method

Available as of:

V2.12.1.0

Versions:

Current version

This chapter provides information on:

Task

Get the optional parameters for a T-Series collision handler.

Description

This method is used get the value for the optional parameters of a T-Series collision handler. For more details on the optional parameters refer to ST_CollisionHandlerTSeriesOptionalParameters.

Interface

Output

Data type

Description

q_xError

BOOL

The output is set to TRUE if an error has been detected during the execution.

q_etResult

ET_Result

POU-specific output on the diagnostic; q_xError = FALSE -> Status message; q_xError = TRUE -> Diagnostic message.

q_sResultMsg

STRING[80]

Event-triggered message that gives additional information on the diagnostic state.

Return Value

Data type:

Description:

ST_CollisionHandlerTSeriesOptionalParameters

The value for the optional parameters is returned.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Successful

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Successful