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] [Next]