IF_CarrierConfiguration - SetIfUserDataAccess (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Connecting a user-defined function block to a carrier.

Description

With the method SetIfUserDataAccess, you can connect your function block to a carrier.

  1. Create a function block (for example FB_UserDataColor) that implements:
    • the interface IF_UserDataAccess for connecting your function block to the carrier

    • an interface for your specific data (for example IF_UserDataColor)

  2. Connect your function block to the carrier with the method SetIfUserDataAccess .

    Code example for assigning the function block FB_UserDataColor to carrier 1:
    i_ifMulticarrier.raifCarrier[1].ifConfiguration.SetIfUserDataAccess(
            i_ifUserDataAccess    :=    fbUserDataColor,
            q_xError              =>    xError,
            q_etResult            =>    etResult,
            q_etResultMsg         =>    sResultMsg);
  3. In an application function block (for example FB_LoadColorStation), the user-defined function block (for example FB_UserDataColor) is now accessible via the property ifUserDataAccess.
    Code example:
    IF i_ifCarrier <> 0
        AND_THEN i_ifCarrier.ifConfiguration.ifUserDataAccess <> 0
        AND_THEN i_ifCarrier.ifConfiguration.ifUserDataAccess.xUserDataAdded
    THEN
        xSuccessGetIfUserData  := _QUERYINTERFACE(i_ifCarrier.ifConfiguration.ifUserDataAccess, ifUserDataColor);
    END_IF

Inputs

Input

Data type

Description

i_ifUserDataAccess

IF_UserDataAccess

Interface that must be implemented in a user-defined function block to connect this function block to the carrier.

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.