Cicode Programming Reference > Cicode Function Categories > Page Functions > PagePeekLast

PagePeekLast

Gets information about a Page at an offset in the page navigation history.

Note: This function is not supported in the server process in a multiprocessor environment. Calling this function from the server process results in a hardware alarm being raised.

Syntax

PagePeekLast(iOffset [, iType] )

iOffset:

Pages are navigated using page navigation history. iOffset is used to indicate the position in that history. An iOffset value of "0" represents the currently viewed page. Positive increments of iOffset indicate previous pages visited in the navigation history. Negative values of iOffset are used to indicate pages in the future of the navigation history (negative iOffsets exist only if the user has used the back button to revisit earlier pages in the history).

For example:

If you navigate pages in the sequence A, B, C, D, E, and then remain on Page E. The iOffset value indicates the following pages:

iOffset value:		4 3 2 1 0
corresponding page: A B C D E

If you then navigate "Back" twice the iOffset value indicates the following pages:

iOffset value:		2 1 0 -1 -2
corresponding page: A B C D E

If you further navigate to pages F then G the iOffset value indicates the following pages:

iOffset value:		4 3 2 1 0
corresponding page: A B C F G

iType:

An enumeration representing the type of information required. The default value is 0.

0 - Page Name

1 - Configured Page Title

2 - Active Page Title

Return Value

String value of the requested information, or empty string if no valid result for given arguments.

Related Functions

PagePeekCurrent, PagePopLast, PagePopUp, PagePushLast

See Also

Page Functions

Published June 2018