itpserver_parameter

With the function itpserver_parameter you can pass information back to ITP/Server or ITP/OnLine Server when the model is run by ITP/Server or ITP/OnLine Server.

itpserver_parameter ( parameter_name; return_value )

The function result is type BOOL. The function will always return TRUE. The function has two parameters divided by semicolons (;):

1. parameter_name, type TEXT. This is the name of the parameter as it is known or will be used in ITP/Server.
2. return_value, type TEXT. This is the value to be returned for the parameter.

This function is intended to be used with the itp_parameter function in ITP/Server scripts. The data marked and passed with itpserver_parameter function in a model can be read in an ITP/Server script with the itp_parameter function. In order to retrieve the value the itp_parameter function takes the identifier 'parameter_name' set in itpserver_parameter as parameter.

Note

ITP Models using this feature can be created with ITP/Workstation, but to run a model containing this feature, you will need ITP/Server or ITP/OnLine Server.

Example

In the model:

BOOL dummy := itpserver_parameter ("print"; "yes, please") 

Note that the variable dummy is used to contain the return value of the function.

In the ITP/Server script:

do_we_print_it = itp_parameter ("print"); 

Note

The function itpserver_parameter supersedes the function itpds_parameter, which is obsolete now.