FB_CoreStation - DeleteAllCarriers (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Deleting the stored carriers from the station.

Description

With the method DeleteAllCarriers, you can delete the carriers that have been added to the internal storage of the station or that have been handed over to the station from the previous station.

NOTE: When this method is executed, the station does no longer have access to the carriers.

Inputs

The method has no inputs.

Outputs

Output	Data type	Description
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 Specifier

The method DeleteAllCarriers is assigned the access specifier FINAL. This helps to protect the method from being overwritten.

For more information, see Mandatory Access Specifiers.