peoplecodeapi - EndModal

Syntax

EndModal(returnvalue)

Description

Use the EndModal function to close a currently open secondary page. It is required only for secondary pages that do not have OK and Cancel buttons. If the secondary page has OK and Cancel buttons, then the function for exiting the page is built in and no PeopleCode is required.

Important! Do not use multiple EndModal or EndModalComponent invocations to close multiple, open modal secondary windows simultaneously. Each modal window must be closed individually with a single EndModal call followed by an event that triggers a trip to the application server. Otherwise, multiple, simultaneous EndModal or EndModalComponent invocations will close all open modal secondary windows.

Parameters

Field or Control	Definition
`returnvalue`	A Number value that determines whether the secondary page data is copied back to the parent page. A positive value runs SaveEdit PeopleCode and copies the data (this is the same as clicking the OK button). A value of zero skips SaveEdit and discards buffer changes made in the secondary page (this is the same as clicking the Cancel button). This value becomes the return value of the DoModal function that started the secondary page, and it can be tested after the secondary page is closed.

Field or Control

Definition

returnvalue

A Number value that determines whether the secondary page data is copied back to the parent page. A positive value runs SaveEdit PeopleCode and copies the data (this is the same as clicking the OK button). A value of zero skips SaveEdit and discards buffer changes made in the secondary page (this is the same as clicking the Cancel button). This value becomes the return value of the DoModal function that started the secondary page, and it can be tested after the secondary page is closed.

Returns

None.