Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSSESMGR
 
typedef struct _STARTDATA {    /* stdata */
    USHORT Length;
    USHORT Related;
    USHORT FgBg;
    USHORT TraceOpt;
    PSZ    PgmTitle;
    PSZ    PgmName;
    PBYTE  PgmInputs;
    PBYTE  TermQ;
    PBYTE  Environment;
    USHORT InheritOpt;
    USHORT SessionType;
    PSZ    IconFile;
    ULONG  PgmHandle;
    USHORT PgmControl;
    USHORT InitXPos;
    USHORT InitYPos;
    USHORT InitXSize;
    USHORT InitYSize;
} STARTDATA;
 
The STARTDATA structure contains information about a session that will be
started with the DosStartSession function.
 
Field        Description
────────────────────────────────────────────────────────────────────────────
 
Length       Specifies the size of the structure (in bytes). Programs
             written in the C language should use the sizeof operator to set
             this field.
 
Related      Specifies whether the session created is related to the calling
             session. If this field is FALSE, the new session is an
             independent session (not related). If it is TRUE, the new
             session is a child session (related).
 
FgBg         Specifies whether the new session is started in the foreground
             or in the background. If this field is TRUE, the session is
             started in the background. If it is FALSE, the session is
             started in the foreground.
 
TraceOpt     Specifies whether the program started in the new session is
             executed under conditions for tracing. If this field is 0,
             there is no tracing. If it is 1, there is tracing.
 
PgmTitle     Points to the null-terminated string that specifies the program
             title. The string can be up to 32 bytes long, including the
             null terminating character. If the address specified is zero or
             if the null-terminated string is NULL, the initial title is the
             value of the PgmName field minus any leading drive and path
             information.
 
PgmName      Points to the null-terminated string that specifies the drive,
             path, and filename of the program to be loaded.
 
PgmInputs    Points to the null-terminated string that specifies the input
             arguments to be passed to the program.
 
TermQ        Points to the null-terminated string that specifies the full
             path name of an MS OS/2 queue or is equal to zero. This
             parameter is optional.
 
Environment  Points to an environment string that is to be passed to the
             program started in the new session. If this field is zero, the
             program in the new session inherits the environment of the
             parent session if the InheritOpt field is zero, or the
             environment of the program calling DosStartSession if the
             InheritOpt field is one.
 
InheritOpt   Specifies whether the program started in the new session
             inherits the environment and open file handles of the calling
             process. If this field is zero, inheritance is from the parent
             session. If this field is 1, inheritance is from the calling
             process.
 
SessionType  Specifies the type of session that should be created. It is one
             of the following values:
 
             Value  Meaning
             ───────────────────────────────────────────────────────────────
             0      Use the data specified by the PgmHandle field or allow
                    MS OS/2 to establish the session type.
 
             1      Start the process in a full-screen session.
 
             2      Start the process in a window session for programs using
                    the base video subsystem.
 
             3      Start the process in a window session for programs using
                    the Presentation Manager application programming
                    interface.
 
IconFile     Points to a null-terminated string that contains the
             fully-qualified device, path name, and filename of an icon
             definition. The system provides an icon for window applications
             if an icon filename is not provided by the DosStartSession
             call.
 
PgmHandle    Specifies a program handle.
 
PgmControl   Specifies the initial state for a window application. This
             field is ignored by full-screen sessions. It can be any
             combination of the following values:
 
             Value  Meaning
             ───────────────────────────────────────────────────────────────
             0      Invisible
 
             2      Maximize
 
             4      Minimize
 
             8      No auto close
 
             32768  Use specified position and size
 
InitXPos     Specifies the initial x-coordinate (in pels) for the
             initial-session window, where (0,0) is the lower-left corner of
             the display. This field is ignored for full-screen sessions.
 
InitYPos     Specifies the initial y-coordinate (in pels) for the
             initial-session window, where (0,0) is the lower-left corner of
             the display. This field is ignored for full-screen sessions.
 
InitXSize    Specifies the width (in pels) for the initial-session window.
             This field is ignored for full-screen sessions.
 
InitYSize    Specifies the height (in pels) for the initial-session window.
             This field is ignored for full-screen sessions.
 
See Also
 
DosStartSession
 
                                      ♦