WPDesktop
implements the &os2; Desktop.
Since the Desktop is just a special folder, in addition to the
strings listed below, the Desktop also supports the strings of the
WPObject
and WPFolder
classes.
To get the currently open Desktop, invoke these strings on the object
with the ID <WP_DESKTOP>
.
AUTOLOCKUP={YES|NO}
LOCKUPTIMEOUT
).
The default is NO
.
LOCKUPAUTODIM={YES|NO}
YES
.
LOCKUPBACKGROUND=name,mode,factor,bgtype,bgcol
BACKGROUND
string.
LOCKUPFULLSCREEN={YES|NO}
YES
, the lockup background specified by LOCKUPBACKGROUND
is displayed when the system is locked up. If NO
, only a message
box is to be displayed prompting you to enter your lockup password.
The default is YES
.
LOCKUPONSTARTUP={YES|NO}
NO
.
LOCKUPTIMEOUT=n
AUTOLOCKUP
is not enabled.
SHOWHELPPANEL=[XWP|filename,]panelid (&xwp; only)
.HLP
file. This can be
used by applications or REXX scripts to have help displayed, either from
a system help panel or from a custom help panel that ships with an application.
With &os2;, each help panel in a .HLP file is assigned a unique number, the
panelid
.
As a result, any help panel can be identified by specifying the help filename
and that ID.
With SHOWHELPPANEL
, the panel to be displayed can be specified in
several ways:
XWP,panelid
specifies a panel from &xwp;'s own help
file, XFLDRxxx.HLP. XWP
is a shortcut for the file name so you
do not have to know the current language code. The help panel ID's used by
&xwp; can be found in the helpids.h
file in the
toolkit\shared
directory.
panelid
is specified only, it is assumed to specify
a help panel in &os2;'s WPHELP.HLP
file.
filename
, you can open any help
file on the system. If the file resides in one of the directories along the
HELP
system path, you
can omit the full path of the file.
If startupdir is set to DEFAULT, the dialog's entry field for the startup directory will be initially empty (which means that the root directory of the boot drive should be used). Any other value will be used as the initial value for the startup directory.
Note 1: This setup string changes no settings, but is a rather a command to be performed immediately.
Note 2: If you invoke this setup string programatically (either through
WinSetObjectData
or SysSetObjectData
),
that function will not return until the dialog has been dismissed.
Example: SHOWRUNDLG=F:\OS2 will show the "Run" dialog
with the startup directory field set to F:\OS2.
XSHUTDOWNNOW=settings (&xwp; only)
Note 1: This setup string changes no settings,
but is a rather a command to be performed immediately.
The below Note 2: If you invoke this setup string programatically (either through
To override the preconfigured behavior after &xshutdown; has completed, use one
of the following:
To override the preconfigured setting for To override the preconfigured animation settings, use either
To override the preconfigured confirmation setting, use either
If you do not want to override any settings, specify Examples:
settings
will only affect this one system shutdown.
WinSetObjectData
or SysSetObjectData
) and confirmations
are enabled, that function will not return until the confirmation dialog has
been dismissed.
settings
is a comma-separated list of &xshutdown; settings
or DEFAULT
. You can specify any combination of what's listed below.
In general, if one of the keywords below is not specified, &xshutdown; will use
what is specified on the "&xshutdown;" page in the Desktop's properties notebook.
HALT
will perform a full shutdown and
show the "It is now safe..." message and then
halt the system after shutdown has completed.
REBOOT
will perform a full shutdown and then do a standard reboot.
USERREBOOT(cmd)
will
perform a full shutdown and then
attempt to do a user-defined reboot
with the reboot action cmd
.
POWEROFF
will
perform a full shutdown and then
attempt an APM power-off, if this is supported on
the system.
RESTARTWPS
will not shut down the system, but only restart the
WPS.
FULLRESTARTWPS
will not shut down the system, but only restart the
WPS, but close all open sessions first and reuse the &xwp; startup folder at
the next Desktop startup.
To override the preconfigured treatment of VIO windows,
use either AUTOCLOSEVIO
or NOAUTOCLOSEVIO
.
XSHUTDWN.LOG
,
use either LOG
or NOLOG
.
ANIMATE
or NOANIMATE
.
CONFIRM
or NOCONFIRM
. Note that if confirmations are on
(either because CONFIRM
was specified or because it was preconfigured
and not overridden), most of the settings specified with XSHUTDOWNNOW
will only cause the confirmation dialog to display different defaults.
DEFAULT
.
XSHUTDOWNNOW=DEFAULT
will start &xshutdown; with the current
settings.
XSHUTDOWNNOW=RESTARTWPS,NOCONFIRM,LOG
will restart the WPS now
without confirmation, but enable logging this one time.