Start Page>SiteKiosk Object>Config Object>StartPage Object>GetStartpage Method


GetStartpage Method


 
The GetStartpage method returns the full path of one of the current startpages.


Syntax 

    [str=] SiteKiosk.Config.StartPage.GetStartpage(mainwin, allowsp)
Parameters
    mainwin Boolean value that specifies whether to determine the path of the main window page or the new window page.
    allowsp Boolean value that specifies whether to determine the session start page defined by the payment device.
Return Value
    Returns a String that contains the path of the current startpage.
Remarks
    Startpage templates can define different pages for the main window and new browser windows. A session start page can be defined by a payment device.
Examples
    The following example shows the path of the startpage of the main window in an alert window. 

    <SCRIPT TYPE="text/javascript">
window.external.InitScriptInterface();
alert(SiteKiosk.Config.StartPage.GetStartpage(true, false));
</SCRIPT>

Applies to
    SiteKiosk v6.0 (and later versions).
Back to top