IF_MulticarrierConfiguration - ConfigureArrayOfMulticarrierSegments (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Setting the array of SystemConfigurationItf.IF_MulticarrierSegment.

Description

With the method ConfigureArrayOfMulticarrierSegments, the array of IF_MulticarrierSegment is set for the Lexium™ MC multi carrier transport system.

Before calling this method, segment objects must be assigned to the array [1...GPL.Gc_udiMaxNumberOfSegments] of SystemConfigurationItf.IF_MulticarrierSegment.

For more information on system configuration, refer to the SystemConfigurationItf library.

Inputs

Input	Data type	Description
i_aifMulticarrierSegment	ARRAY [1...GPL.Gc_udiMaxNumberOfSegments] OF SystemConfigurationItf.IF_MulticarrierSegment	Specifies the array of IF_MulticarrierSegment.
i_udiNumberOfSegments	UDINT	Specifies the number of segments.

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.

Call examples

The elements of the array must be assigned in the order of the segment alignment, starting with array element 1.

GVL.G_aifMulticarrierSegment [1] = MC_Segment_1
GVL.G_aifMulticarrierSegment [2] = MC_Segment_2
...
ifMulticarrierConfiguration.ConfigureArrayOfMulticarrierSegments(…)