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}

Determines whether the auto-lockup feature is enabled (whether the keyboard and mouse will automatically lock up after a period of inactivity -- see LOCKUPTIMEOUT). The default is NO.

LOCKUPAUTODIM={YES|NO}

Determines whether the auto-dim feature is enabled (whether the screen blanks out and a floating lock icon is displayed two minutes after the keyboard and mouse have been locked). The default is YES.

LOCKUPBACKGROUND=name,mode,factor,bgtype,bgcol

Sets the lockup background. The format is the same as with the WPFolder BACKGROUND string.

LOCKUPFULLSCREEN={YES|NO}

Determines whether lockup will use the full screen. If 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}

Determines whether the system is automatically locked up after startup (or after it has been restarted). The default is NO.

LOCKUPTIMEOUT=n

Specifies the number of minutes of keyboard and mouse inactivity after which the system will automatically locked up. The setting is ignored if AUTOLOCKUP is not enabled.

SHOWHELPPANEL=[XWP|filename,]panelid (&xwp; only)

Displays any help page ("panel") from any .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:

SHOWRUNDLG=startupdir (&xwp; only)
Shows the &xwp; "Run" dialog, as with the "Run" command from the &xcenter; &xbutton; widget.

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)

Starts &xshutdown; now with the specified settings, which correspond to the various settings on the "&xshutdown;" page in the Desktop's properties notebook.

Note 1: This setup string changes no settings, but is a rather a command to be performed immediately. The below settings will only affect this one system shutdown.

Note 2: If you invoke this setup string programatically (either through 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.

To override the preconfigured behavior after &xshutdown; has completed, use one of the following:


To override the preconfigured treatment of VIO windows, use either AUTOCLOSEVIO or NOAUTOCLOSEVIO.

To override the preconfigured setting for XSHUTDWN.LOG, use either LOG or NOLOG.

To override the preconfigured animation settings, use either ANIMATE or NOANIMATE.

To override the preconfigured confirmation setting, use either 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.

If you do not want to override any settings, specify DEFAULT.

Examples: