itpserver_parameter

This function is deprecated. Use the Field Set _Document instead (see _Document).

With the itpserver_parameter function, you can pass information back to Communications Manager Core or Communications Manager ComposerUI Server when the Master Template is run by Communications Manager Core or Communications Manager ComposerUI Server.

 itpserver_parameter ( parameter_name;
return_value )

The function result is of type BOOL. The function always returns TRUE.

The itpserver_parameter function has two parameters divided by semicolons:

1. parameter_name, type TEXT. This is the name of the parameter as it is known or used in Communications Manager Core.
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 Communications Manager Core scripts. The data marked and passed with itpserver_parameter function in the Master Template can be read in a Communications Manager Core script with the itp_parameter function. To retrieve the value, the itp_parameter function takes the identifier parameter_name set in tpserver_parameter as parameter.

An example is provided here.

In the Master Template.

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

The variable dummy is used to contain the return value of the function in the Communications Manager Core script.

do_we_print_it = itp_parameter
("print");

The function itpserver_parameter supersedes the function itpds_parameter that is obsolete now.