ItpSetSubroutinePathEx

ItpSetSubroutinePathEx 1:

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

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

  1. optional search path (ItpSetSubroutinePath)
  2. path from which the main program was loaded
  3. TwinCAT\Mc\Nci 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 path has to be re-assigned.

VAR_INPUT

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

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

sPath: Optional path for subroutines. Is deactivated with an empty string

nLength: String length

tTimeOut: ADS Timeout-Delay

VAR_IN_OUT

VAR_IN_OUT
    sNciToPlc           : NCTOPLC_NCICHANNEL_REF;
END_VAR

sNciToPlc: The structure of the cyclic channel interface from the NCI to the PLC. This structure is only accessed for reading. (type: NCTOPLC_NCICHANNEL_REF)

VAR_OUTPUT

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

bBusy: 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: 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: 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).

ItpSetSubroutinePathEx 2:

Not Available for GST

This function block is not available if the GST interpreter is employed.

Requirements

Development environment

Target platform

PLC libraries to be linked

TwinCAT v3.1.0

PC or CX (x86 or x64)

Tc2_NCI