notifyToWindow method: PrcsAPI class

Syntax

notifyToWindow(PrcsInstance, Message)

Description

Use the notifyToWindow method to display additional messages to the window.

If a process is not defined as going to Window, using this method has no effect. The purpose of this method is to display additional messages to the window when an Application Engine process (no other process type) is run to Window.

Parameters

Parameter	Description
PrcsInstance	Specify the process instance for which you want to display messages, as a number.
Message	Specify the message you want displayed, as a string.

Returns

A number: 0 if method failed.

Example

The following PeopleCode would be in a step in an application engine program.

import PT_PRCS:API:*;

Local PrcsApi &api = create PrcsApi();

/* QE_AESTATUS_AET is the sate record for this Application Engine program */

&nret = &api.notifyToWindow(QE_AESTATUS_AET.PROCESS_INSTANCE, "Hi There! this is⇒
 First step."); 

/* this displays the message on the window */