RenamePage function

Syntax

RenamePage(Page.NewPageName, Page.OldPageName)

Description

Use the RenamePage function to modify a page definition to have a new name. This function also cleans up most references so they now use the new name.

Parameters

Parameter Description

NewPageName

Specify the new page name to be used. This name must be prefixed by the reserved word Page.

OldPageName

Specify the name of the page to be changed. This name must be prefixed by the reserved word Page.

Returns

A constant value. The values are:

Value Description

%MDA_Success

Bulk operation completed successfully.

%MDA_Failure

Bulk operation did not complete successfully.

%MDA_PageNotFound

The page specified with OldPageName wasn't found.

Example

&ret =  RenamePage(PAGE.OrgIdTbl, PAGE.DeptIdTbl);  
If (&ret = %MDA_Success) Then 
   MessageBox(0, "Metadata Fn Status", 0, 0, "RenamePage succeeded"); 
Else 
   MessageBox(0, "Metadata Fn Status", 0, 0, "RenamePage failed"); 
End-If;

Considerations Using this Function

This function is intended for use during configuration time only, before active runtime usage is initiated. Using this function during active runtime is not supported. Changes to data definitions are not recognized on currently loaded component. In general, changes aren't recognized until the component is reloaded.

This operation is time consuming

WARNING:

These operations take place in a separate transaction from the page's save status: the initiation of any of these operations immediately changes the definitions, even if the page is subsequently cancelled.