IF_CarrierConfiguration - GetMulticarrierCarrierObject (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Accessing the carrier object Lexium MC Carrier from the Devices tree.

Description

With the method GetMulticarrierCarrierObject, you can access the carrier object of the device for the selected carrier.

With QueryInterface, you can cast the implemented interfaces, for example IF_Master.

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

For more information on the carrier object Lexium MC Carrier, refer to the Lexium™ MC multi carrier Device Objects and Parameters Guide.

Inputs

The method has no inputs.

Return values

Return value

Data type

Description

GetMulticarrierCarrierObject

SystemConfigurationItf.IF_MulticarrierCarrier

Access to the interface of the carrier object.

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

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.