Start Page>SiteKiosk Object>Config Object>ExpandPathVariables Method

ExpandPathVariables Method


 
The ExpandPathVariables method expands a string's path (and system) variables.


Syntax 

    [str=] SiteKiosk.Config.ExpandPathVariables(varStr, sysVars)
Parameters
    varStr String that specifies the string containing variables.
    sysVars Boolean value that indicates whether also to expand system variables.
Return Value
    Returns the given String with expanded path (and system) variables.
Remarks
    Notation of SiteKiosk variables: $(...)
    Depending on the local system, the string '$(SiteKioskPath)\skins' may be expanded to 'c:\program files\sitekiosk\skins'.

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

    <SCRIPT TYPE="text/javascript">
window.external.InitScriptInterface();
folder = "$(SiteKioskPath)\skins";
folder = SiteKiosk.Config.ExpandPathVariables(folder, false);
alert(folder);
</SCRIPT>

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