SessionVar Help File
Welcome
|
(string) SessionVar.Expand
( |
(string) Text
) |
Description
Returns a string containing the contents of the given session
variable.
Parameters
Text
(string) The session
variable string you want to expand.
Return
This action returns a (string)
value.
|
(string) SessionVar.Get ( |
(string) VariableName
) |
Description
Returns the unexpanded contents of a session variable.
Parameters
VariableName
(string) The name of the
session variable whose contents you want.
Return
This action returns a (string)
value.
|
SessionVar.Remove ( |
(string) VariableName
) |
Description
Removes the given session variable from the session variable
manager at runtime.
Parameters
VariableName
(string) The name of the
session variable you want to remove (undefine).
Return
This action dose not return any value.
|
SessionVar.Set ( |
(string) VariableName,
(string) Value
) |
Description
Sets the given session variable to the specified value.
Parameters
VariableName
(string) The name of the
session variable whose value you want to set.
Value
(string) The value you want
to set the session variable to.
Return
This action dose not return any value.
|
(table) SessionVar.GetAll () |
|
Description
Returns all contents of a session variable.
Parameters
None
Return
This action returns a (table)
value.
Session variables are special types of variables that are expanded at
runtime when they are used. When they are used on screens, their values are
automatically expanded for you, however if a session variable is used in an
action script, it must be manually expanded using the SessionVar.Expand
action.
While there are predefined session variables available to use, you can also
create custom session variables at design time and run time. At design time,
they can be defined on the Session Variables tab of the Project Settings dialog.
At run time, you can create and manipulate session variables using the available
SessionVar actions.
The following pre-defined session variables are available in this
plugin:
%ApplicationDataFolder%
The path to the per-user
Application Data folder on the user's system. This folder serves as a common
repository for application-specific data. Typically, this path is something like
"C:\Documents and Settings\YourName\Application Data." On Windows Vista or
later, it would return something like "C:\Users\YourName\AppData\Roaming."
%ApplicationDataFolderCommon%
The path to the all-user
Application Data folder on the user's system. This folder servers as a common
repository for application-specific data. Typically this is something like
"C:\Documents and Settings\All Users\Application Data." On Windows Vista or
later, this returns "C:\ProgramData."
%CommonDocumentsFolder%
The path to the documents
folder common to all users. Usually this is something like "C:\Documents and
Settings\All Users\Documents."
%CommonFilesFolder%
The user's Common Files folder.
Typically, this is something like: C:\Program Files\Common Files.
%DesktopFolder%
The path to the user's Desktop folder.
On Windows NT/2000/XP/Vista or later, this is the path from the per-user
profile.
%DesktopFolderCommon%
The path to the user's Desktop
folder. On Windows NT/2000/XP,Vista or later this is the path from the All Users
profile. On a non-Windows NT system, this will simply be the path to the user's
Desktop folder (the same as _DesktopFolder).
%FontsFolder%
The path to the user’s font directory
(e.g. "C:\Windows\Fonts").
%MyMusicFolder%
The path to the user's My Music folder.
For example "C:\Documents and Settings\User\My Documents\My Music."
%MyMusicFolderCommon%
The path to the All Users profile
My Music folder, for example "C:\Documents and Settings\All Users\Documents\My
Music." Only available on Windows XP/Vista or later.
%MyPicturesFolder%
The path to the user's My Pictures
folder. For example "C:\Documents and Settings\username\My Documents\My
Pictures." Only available on Windows 98 SE or later with minimum IE 5.0
installed.
%MyPicturesFolderCommon%
The path to the All User
profile My Pictures folder, for example "C:\Documents and Settings\All
Users\Documents\My Pictures." Only available on Windows XP/Vista or later.
%MyVideosFolder%
The path to the user's My Videos
folder. For example "C:\Documents and Settings\username\My Documents\My Videos."
Only available on Windows XP/Vista or later.
%MyVideosFolderCommon%
The path to the All User profile
My Videos folder. For example "C:\Documents and Settings\All Users\Documents\My
Videos." Only available on Windows XP/Vista or later.
%ProgramFilesFolder%
The user's Program Files folder
(typically, this is something like "C:\Program Files").
%SourceFolder%
The full path to the folder that the
installation executable was run from (e.g. "C:\Downloads" or "D:\").
%StartFolder%
The path to the user's Start menu folder.
On Windows NT/2000/XP/Vista or later, this is the path from the per-user
profile.
%StartFolderCommon%
The path to the user's Start menu
folder. On Windows NT/2000/XP/Vista or later, this is the path from the All
Users profile. On a non-Windows NT system, this will simply be the path to the
user's Start menu folder (the same as %StartFolder%).
%StartProgramsFolder%
The path to the Programs folder
in the user's Start menu. On Windows NT/2000/XP/Vista or later, this is the path
from the per-user profile.
%StartProgramsFolderCommon%
The path to the Programs
folder in the user's Start menu. On Windows NT/2000/XP/Vista or later, this is
the path from the All Users profile. On a non-Windows NT system, this will
simply be the path to the Programs folder in the user's Start menu (the same as
%StartProgramsFolder%).
%StartupFolder%
The path to the user's Startup folder.
On Windows NT/2000/XP/Vista or later, this is the path from the per-user
profile.
%StartupFolderCommon%
The path to the user's Startup
folder. On Windows NT/2000/XP/Vista or later, this is the path from the All
Users profile. On a non-Windows NT system, this will be the path to the user's
Startup folder (the same as %StartupFolder%).
%SystemFolder%
The path to the user’s Windows System
folder (e.g. "C:\Windows\System" on non-NT systems, and "C:\Windows\system32" on
NT-based OS's).
%TempFolder%
The path to the user's Temp folder.
%TempLaunchFolder%
The path to the temporary directory
where Setup Factory extracts the files it will need for the installation. (For
example, this is the directory where Primer files are extracted to.) During the
uninstall, this variable contains the path to the uninstall files folder. This
is the folder that the uninstall configuration file is located.
Usually this directory will be the user's temporary directory, unless the
user overrides the temporary directory with the /T command line option.
%WindowsFolder%
The path to the user’s Windows folder
(e.g. "C:\Windows").
Made with Action Plugin Compiler