Procedure object handle

A handle that can reference the context of one of the following procedure object instances:

A persistent procedure in the current session

A persistent procedure in a remote session (on an AppServer)

A single-run or singleton procedure in a remote session (on an AppServer)

A running procedure in the current session, including the currently executing procedure or any other procedure currently on the session call stack

A procedure object that encapsulates a Web service operation (Web service procedure object)

This object allows you to read and modify the context of the specified procedure according to the type of procedure object instance.

Syntax 

 

procedure-handle [ :attribute | :method ]

procedure-handle

A handle variable that references a procedure object.

For Web services, this object is instantiated when you execute the RUN ON statement that references a Web service server object.

attribute

An attribute of a procedure handle.

method

Specifies a method of a procedure handle.

Attributes

 

ADM-DATA attribute	ASYNC-REQUEST-COUNT attribute	CURRENT-WINDOW attribute
DB-REFERENCES attribute	FILE-NAME attribute	HANDLE attribute
INSTANTIATING-PROCEDURE attribute	INTERNAL-ENTRIES attribute	NAME attribute
NEXT-SIBLING attribute	PERSISTENT attribute	PREV-SIBLING attribute
PRIVATE-DATA attribute	PROXY attribute	PUBLISHED-EVENTS attribute
REMOTE attribute	SERVER attribute	SUPER-PROCEDURES attribute
SINGLE-RUN attribute	SINGLETON attribute	TRANSACTION attribute
TYPE attribute	UNIQUE-ID attribute	–

Methods

 

ADD-SUPER-PROCEDURE( ) method	GET-SIGNATURE( ) method
REMOVE-SUPER-PROCEDURE( ) method	SET-CALLBACK-PROCEDURE( ) method

Example 

The following procedure runs another procedure (r-thispr.p) persistently, setting a procedure object handle for it, and displays the value of its PRIVATE-DATA attribute as a message:

 

r-run-thispr-pers.p

DEFINE VARIABLE hthispr AS HANDLE NO-UNDO.   RUN r-thispr.p PERSISTENT SET hthispr.   MESSAGE "Running the " hthispr:PRIVATE-DATA VIEW-AS ALERT-BOX INFORMATION.

For more information on the r-thispr.p example procedure, see the reference entry for the THIS-PROCEDURE system handle in this section.

Notes 

You can also define triggers for procedure object handles.

To create an instance of a persistent procedure, use the PERSISTENT option of the RUN statement, as shown for the r-run-thispr-pers.p example procedure. For other examples of creating persistent procedures, see the reference entry for the RUN statement.

You can access the handles and attributes of all persistent procedure instances in a session using the FIRST-PROCEDURE or LAST-PROCEDURE attribute of the SESSION handle.

See also 

RUN statement, SESSION system handle, THIS-PROCEDURE system handle