GETHANDLE

Usage

TIBCO iProcess Workspace (Windows)

Warning: (iProcess only) This expression is not available to the TIBCO iProcess Script Server Plug-in. Therefore, even though you can successfully enter the expression in your iProcess Script plug-in definition, it will not be processed by the iProcess Engine. It will return SW_NA.

Returns the handle (internal reference number) of a specified item.

Syntax

GETHANDLE (itemid)

where itemid is a numeric value specifying which item to return the handle of:

Value

Handle to return

0

SAL session handle

1

SAL mail session handle (obsolete - always returns -1).

2

SAL form session handle

3

Form window handle

4

Work queue window handle

5

Tools window handle

Returns

A numeric value which is the handle to be used in calls to SAL API functions. If the argument is invalid or the specified handle cannot be returned, the return value is -1.

Examples

TIBCO iProcess Modeler:

To return the SAL session handle in a call to a custom Windows application to handle form input:

WINRUN ("c:\myprog " + STR (GETHANDLE (0), 0), 1)

TIBCO Business Studio:

IPEExternalUtil.WINRUN("c:\\myprog " + IPEConversionUtil.STR(IPEEnvironmentUtil.GETHANDLE(0),0),1);