WPProgram

Class definition file: wppgm.idl

Class hierarchy SOMObject
WPObject
WPAbstract
WPProgram

Description

This is the program object class. This class provides an object that points to executable programs and allows the user to run that program by simply double-clicking on the program object. The program can also contain a variety of useful additional parameters, such as the environment for the program and the parameters that are passed to it. An instance of this class can be created as a Workplace object and is created initially by the system in its template form. It has the title "Program" and resides in the "Templates" folder.

Other instances of this class initially created by the system include:

DOS Full Screen" in the "Command Prompts" folder
DOS Window" in the "Command Prompts" folder
OS/2 Full Screen" in the "Command Prompts" folder
OS/2 Window" in the "Command Prompts" folder
Every object in the "Games" folder
Some objects in the "Information" folder
Every object in the "Productivity" folder

Menu ID list

The following list shows the WPMENUID menu IDs for this class:

Menu item text

Menu ID

Program

WPMENUID_PROGRAM

Instance methods

The following list shows all the WPProgram methods:

wpAddProgramAssociationPage

wpAddProgramEnvironmentPage

wpAddProgramPage

wpAddProgramSessionPage

wpQueryAssociationFilter

wpQueryAssociationType

wpQueryProgDetails

wpQueryProgramAssociations

wpQueryWarnBeforeStart (WPProgram)

wpSetAssociationFilter

wpSetAssociationType

wpSetProgDetails

wpSetProgramAssociations

wpSetProgIcon

wpSetWarnBeforeStart (WPProgram)

SOMObject instance methods

The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.

somDefaultInit

somDestruct

WPObject instance methods

The following list shows all the methods overridden by the WPProgram class. These methods are overridden in order to modify the behavior defined by an ancestor class.

wpMenuItemHelpSelected

wpSetup override by WPProgram

The following table shows the keyname-value pairs added by the WPProgram class.

┌───────────────┬─────────────────────────┬──────────────────────────────┐│KEYNAME        │VALUE                    │DESCRIPTION                   │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│ASSOCFILTER    │filters                  │Sets the filename filter for  │
│               │                         │files associated with this    │
│               │                         │program.  Multiple filters are│
│               │                         │separated by commas.          │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│ASSOCTYPE      │type                     │Sets the type of files        │
│               │                         │associated with this program. │
│               │                         │Multiple types are separated  │
│               │                         │by commas.                    │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│EXENAME        │filename                 │Sets the name of the program. │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│MAXIMIZED      │YES                      │The program window is         │
│               │                         │maximized upon startup.       │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │NO                       │The program window is restored│
│               │                         │to normal upon startup.       │
│               │                         │This is the default setting.  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│MINIMIZED      │YES                      │The program window is         │
│               │                         │minimized upon startup.       │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │NO                       │The program window is restored│
│               │                         │to normal upon startup.       │
│               │                         │This is the default setting.  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│PROGTYPE       │DOSMODE                  │Sets the session type to      │
│               │                         │stand-alone DOS mode.         │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │FULLSCREEN               │Sets the session type to OS/2 │
│               │                         │full-screen mode.             │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PM                       │Sets the session type to PM.  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_30_STD              │Sets the session type to      │
│               │                         │standard compatibility full   │
│               │                         │screen mode.                  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_ENH              │Sets the session type to      │
│               │                         │enhanced compatibility full   │
│               │                         │screen mode.                  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_ENHSEAMLESSCOMMON│Sets the session type to      │
│               │                         │WIN-OS/2* window in the       │
│               │                         │WIN-OS/2 enhanced             │
│               │                         │compatibility common session. │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_ENHSEAMLESSVDM   │Sets the session type to      │
│               │                         │WIN-OS/2 window in a separate │
│               │                         │session enhanced compatibility│
│               │                         │mode.                         │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_STD              │Sets the session type to      │
│               │                         │standard compatibility full   │
│               │                         │screen mode.                  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_STDSEAMLESSCOMMON│Sets the session type to      │
│               │                         │WIN-OS/2 window in the        │
│               │                         │WIN-OS/2 standard             │
│               │                         │compatibility common session. │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │PROG_31_STDSEAMLESSVDM   │Sets the session type to      │
│               │                         │WIN-OS/2 window in a separate │
│               │                         │session standard compatibility│
│               │                         │mode.                         │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │SEPARATEWIN              │Sets the session type to      │
│               │                         │WIN-OS/2 window running in a  │
│               │                         │separate VDM.                 │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │VDM                      │Sets the session type to DOS  │
│               │                         │full-screen.                  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │WIN                      │Sets the session type to      │
│               │                         │WIN-OS/2 full screen.         │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │WINDOWABLEVIO            │Sets the session type to OS/2 │
│               │                         │windowed.                     │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │WINDOWEDVDM              │Sets the session type to DOS  │
│               │                         │windowed.                     │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │WINDOWEDWIN              │Sets the session type to      │
│               │                         │WIN-OS/2 window.              │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│NOAUTOCLOSE    │YES                      │Leaves the window open when   │
│               │                         │the program terminates.       │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│               │NO                       │Closes the window when the    │
│               │                         │program terminates.           │
│               │                         │This is the default setting.  │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│PARAMETERS     │params                   │Sets the parameters list,     │
│               │                         │which may include substitution│
│               │                         │characters.                   │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│SET            │XXX=VVV                  │XXX is an environment         │
│               │                         │variable.  VVV sets the value │
│               │                         │of the environment variable.  │
│               │                         │This is also used to specify  │
│               │                         │DOS settings on DOS and       │
│               │                         │Windows** programs.           │
│               │                         │Each variable/value pair must │
│               │                         │be separated by a NULL (\0),  │
│               │                         │and the entire string must be │
│               │                         │terminated by two NULLS       │
│               │                         │(\0\0).  For example: DOS     │
│               │                         │DEVICE=value\0env=value\0\0   │
├───────────────┼─────────────────────────┼──────────────────────────────┤
│STARTUPDIR     │pathname                 │Sets the working directory.   │
└───────────────┴─────────────────────────┴──────────────────────────────┘

Example

pszSetupString="PROGTYPE=VDM;"
               "EXENAME=C=\EDIT.EXE;"
               "ASSOCFILTER=*.DOC,*.TXT;"
               "ASSOCTYPE=Plain Text;"
               "SET DOS_DEVICE=1.SYS,2.SYS;"
               "SET PATH=C:\FRED";

Class methods

There are currently no class methods defined for the WPProgram Workplace class object.

WPObject class methods

The following list shows all the class methods overridden by the WPProgram class. These methods are overridden to modify the behavior defined by an ancestor class.

[Back: WPPrinter]
[Next: WPProgramFile]