Start Page>SiteKiosk Object>Config Object>GeneralizePath Method

GeneralizePath Method


 
The GeneralizePath method generalizes a string containing paths.


Syntax 

    [str=] SiteKiosk.Config.GeneralizePath(pathStr)
Parameters
    pathStr String that specifies the string containing paths.
Return Value
    Returns the given String with path (and system) variables.
Remarks
    Notation of SiteKiosk variables: $(...)
    Depending on the local system, the string 'c:\program files\sitekiosk\skins' may be generalized to '$(SiteKioskPath)\skins'.

    Notation of system variables: %...%
    Depending on the local system, the string 'c:\windows\system32' may be generalized to '%SystemRoot%\system32'.
Examples
    The following example displays the generalized path of the SiteKiosk folder. 

    <SCRIPT TYPE="text/javascript">
window.external.InitScriptInterface();
folder = SiteKiosk.SiteKioskDirectory;
folder = SiteKiosk.Config.GeneralizePath(folder);
alert(folder);
</SCRIPT>

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