ItpSetSubroutinePathEx

ItpSetSubroutinePathEx 1:

With function block ItpSetSubroutinePathEx, the search path for subroutines can be set optionally.

If a subroutine still has to be integrated, the file is searched in the following order:

  1. Optional search path (ItpSetSubroutinePathEx)
  2. Path that the main program was loaded from
  3. Default directory

Only one optional path can take effect, which remains active until it is overwritten with another path or an empty string.

After a TwinCAT restart, the optional path has to be reassigned.

ItpSetSubroutinePathEx 2: Inputs

VAR_INPUT
    bExecute       : BOOL;
    sPath          : STRING;
    nLength        : UDINT;
    tTimeOut       : TIME;
END_VAR

Name

Type

Description

bExecute

BOOL

The command is triggered by a rising edge at this input.

sPath

STRING

Optional path for subroutines. Is disabled with an empty string.

nLength

UDINT

String length

tTimeOut

TIME

ADS timeout delay

ItpSetSubroutinePathEx 3:/ItpSetSubroutinePathEx 4: Inputs/Outputs

VAR_IN_OUT
    sNciToPlc           : NCTOPLC_NCICHANNEL_REF;
END_VAR

Name

Type

Description

sNciToPlc

NCTOPLC_NCICHANNEL_REF

The structure of the cyclic channel interface from the NCI to the PLC. This structure is read-only (type: NCTOPLC_NCICHANNEL_REF).

ItpSetSubroutinePathEx 5: Outputs

VAR_OUTPUT
    bBusy     : BOOL;
    bErr      : BOOL;
    nErrId    : UDINT;
END_VAR

Name

Type

Description

bBusy

BOOL

This output remains TRUE until the function block has executed a command, but at the longest for the duration supplied to the 'Timeout' input. While Busy = TRUE, no new command will be accepted at the inputs. Please note that it is not the execution of the service but its acceptance whose time is monitored.

bErr

BOOL

This output is switched to TRUE as soon as an error occurs during the execution of a command. The command-specific error code is contained in 'nErrId'. Is reset to FALSE by the execution of a command at the inputs.

nErrId

UDINT

Contains the command-specific error code of the most recently executed command. Is reset to 0 by the execution of a command at the inputs. The error numbers in ErrId can be looked up in the ADS error documentation or in the NC error documentation (error codes above 0x4000).

Requirements

TwinCAT and interpreter version

PLC library to include

Classic dialect interpreter:

  • TwinCAT V3.1.0

Tc2_NCI

GST interpreter:

  • TwinCAT V3.1.4024.68
  • TwinCAT V3.1.4026
    • TwinCAT.XAR.NCI.GST=3.2.18