ItpSetSubroutinePath

With ItpSetSubroutinePath 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:

optional search path (ItpSetSubroutinePath)
path from which the main program was loaded
TwinCAT\Mc\Nci directory

Only one optional path can be active at any one time. It remains active until it is

overwritten with another path or
with an empty string

After a TwinCAT restart, the path has to be re-assigned.

	Outdated version The sole purpose of the function block is to ensure compatibility with existing projects. For new projects please use the function block ItpSetSubroutinePathEx.

Interface

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

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

nChnId: Channel ID

sPath: Optional path for subroutines; is disabled with an empty string.

nLength: String length

tTimeOut: ADS Timeout-Delay

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

Requirements

Development environment	Target platform	PLC libraries to be linked
TwinCAT v3.1.0	PC or CX (x86 or x64)	Tc2_NCI