FB_CoreStation - GetCarrier (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Accessing the interface IF_Carrier for a selected carrier of the station.

Description

With the method GetCarrier, you get access to the interface MCR.IF_Carrier for a carrier that has been selected via the input i_udiElementNumber.

Inputs

Input	Data type	Description
i_udiElementNumber	UDINT	Indicates which carrier is selected from the internal storage of the station.

Outputs

Output	Data type	Description
q_ifCarrier	MCR.IF_Carrier	Carrier object from the Multicarrier library. For more information, refer to the Multicarrier library.
q_xError	BOOL	Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING [255]	Provides additional diagnostic and status information as a text message.

Access Specifiers

The method GetCarrier is assigned the access specifiers FINAL and PROTECTED.

The specifier FINAL helps to protect the method from being overwritten. The specifier PROTECTED ensures that the method can only be called and shown inside a function block inheriting the function block FB_CoreStation.

For more information, see Mandatory Access Specifiers.