Progress
Language Reference
SESSION System Handle
A handle to the current Progress session object. This object allows you to read and modify the current Progress session context.
SYNTAX
attribute
Specifies an attribute of the SESSION handle. The attributes are listed below.
Attribute Type Description LOGICAL If TRUE, the output from all MESSAGE statements in the application are displayed in alert boxes. LOGICAL Specifies whether the current session is running in batch mode. CHARACTER Returns the setting for the Character Set (-charset) parameter. This attribute is obsolete. See the CPINTERNAL Attribute. CHARACTER Returns the type of Progress client currently executing. CHARACTER Specifies the path name of a help (.HLP) file associated with a session. CHARACTER Indicates the case table Progress uses to establish case rules for the memory code page (-cpinternal). CHARACTER Indicates the collation table Progress uses with the memory code page (-cpinternal). CHARACTER Indicates the internal code page Progress uses in memory (-cpinternal). CHARACTER Indicates the code page for all messages written to the log (.lg
) file. CHARACTER Indicates the code page Progress uses for the OUTPUT TO PRINTER statement. CHARACTER Indicates the code page Progress uses to convert text strings into the text segment. CHARACTER Indicates the code page Progress uses at compile time to convert text strings into the text segment and marks the text segment with the code page name. CHARACTER Indicates the stream code page Progress uses for stream I/O (-cpstream). CHARACTER Indicates the code page Progress uses for I/O with character terminals. LOGICAL If TRUE, the RETURN key acts like a TAB in a fill-in. Otherwise, the window system handles the return. CHARACTER Indicates the format used to represent dates. Typical values are mdy or dmy. This attribute provides the same functionality as the Date Format (-d) parameter. LOGICAL Indicates whether Progress provides access to 4GL stack trace information when an error occurs (TRUE) or not (FALSE). CHARACTER Specifies the display type for the session: either TTY (character) or GUI (graphical). HANDLE A handle to the first table that has a buffer object. HANDLE A handle to the first window within the Progress display. HANDLE A handle to the first entry in the chain of persistent procedures for the session. HANDLE A handle to the first entry in the chain of server handles for the session. HANDLE A handle to the first entry in the list of all valid server socket handles created in the current session. HANDLE A handle to the first entry in the list of all valid socket handles created in the current session. INTEGER The space between frames in a window, given in display units (character cells for character interfaces and pixels for graphical interfaces). DECIMAL The height of the display in characters. INTEGER The height of the display in pixels. CHARACTER A character string that supplies Internet Component Framework (ICF) procedures with ICF-related data. LOGICAL If TRUE, Progress updates the screen for every I/O operation. If FALSE, Progress does not update the screen until a statement blocks for input. WIDGET-
HANDLE A handle to the last window within the Progress display. HANDLE A handle to the last entry in the chain of persistent procedures for the session. HANDLE A handle to the last entry in the chain of server handles for the session. HANDLE A handle to the last entry in the list of all valid server socket handles created in the current session. HANDLE A handle to the last entry in the list of all valid socket handles created in the current session. INTEGER This attribute applies to Windows only. It controls how Progress interacts with Window’s cooperative multitasking. CHARACTER Indicates the character that represents, in formatted text, a number’s decimal point. CHARACTER Indicates the meanings of commas and periods within numeric values. The possible values are “American”, “European”, or a character string containing the thousands separator followed by the decimal point. This provides the same functionality as the European Numeric Format (-E) parameter. CHARACTER Indicates the character that represents, in formatted text, a number’s thousands separator. CHARACTER Specifies the value passed to -param for the session. INTEGER The number of pixels in each column of the display. INTEGER The number of pixels in each row of the display. INTEGER This attribute applies to Windows only. The integer identifier of the current context for a print job on Windows. INTEGER The handle to the current Windows device context for a print job. CHARACTER This attribute applies to Windows only. The name of the currently selected printer. CHARACTER This attribute applies to Windows only. The name of the currently selected printer port. LOGICAL TRUE if the current session is running in the context of a Progress AppServer. LOGICAL (AppServer only) TRUE if the AppServer session is bound to a particular client application. Valid only if the REMOTE attribute is TRUE. LOGICAL (AppServer only) When set to TRUE, requests that the AppServer session be bound to the current client connection identified by the SERVER-CONNECTION-ID attribute. When set to FALSE, requests that the the AppServer session be unbound from the currently bound client connection pending deletion of all remote persistent procedures running in the session. Ignored unless the REMOTE attribute is TRUE. CHARACTER (AppServer only) An application-determined value that you can set. Progress passes this value to each Application Server process that executes a request on behalf of the client connection identified by the SERVER-CONNECTION-ID attribute. Valid only if the REMOTE attribute is TRUE. CHARACTER (AppServer only) Returns the run-time connection ID of the current client connection assigned to this AppServer session. Valid only if the REMOTE attribute is TRUE. CHARACTER (AppServer only) Returns the operating mode specified by the operatingMode property set for this AppServer in theubroker.properties
file. Possible values include:Valid only if the REMOTE attribute is TRUE. CHARACTER The setting of the Stream (-stream) parameter. This attribute is obsolete. See the CPSTREAM Attribute. CHARACTER A list of the super procedure handles associated with the current Progress session. LOGICAL If TRUE, Progress does not display warning messages to the screen during the session. LOGICAL If TRUE, system messages are displayed in alert boxes rather than in the message area. CHARACTER The name of the directory Progress uses to store temporary files for the session. LOGICAL This attribute applies to Windows only. If TRUE, system dialog boxes and alert boxes are displayed in three-dimensional format. CHARACTER Specifies whether the source for time (TIME function value) is the client or database server machine. LOGICAL This attribute applies to Windows only. If TRUE, then ToolTip information that is defined for any controls associated with a given session displays when the mouse pointer pauses over a control. Otherwise, ToolTip information does not display for any controls in the session. CHARACTER The SESSION handle widget type, PSEUDO-WIDGET. LOGICAL This attribute applies to Windows only. If TRUE, Progress uses Version 6 display rules for the session. DECIMAL The display width in character units. INTEGER The display width in pixels. CHARACTER The windowing system - specifically, MS-WIN95, MS-WINDOWS, or TTY. INTEGER Indicates the height of the work-area in pixels. INTEGER The starting x-coordinate (the upper left-hand corner) of the work-area in pixels. INTEGER The starting y-coordinate (the upper left-hand corner) of the work-area in pixels. INTEGER Indicates the current start date for the Progress two-digit year-range of 100 years. Typical values are 1920 or 1950. This attribute provides the same functionality as the Year Offset (-yy) parameter.
method
Specifies a method of the SESSION handle.
Method Return Type Description ADD-SUPER-PROCEDURE( ) Method (super-proc-hdl) LOGICAL Associates a super procedure file with the current Progress session. EXPORT( ) Method ( [ list ] ) LOGICAL (AppServer only) Creates and modifies the list of remote procedures provided by the AppServer. CHARACTER Returns a comma-separated list of printers defined in the Windows Registry. CHARACTER Returns a string indicating the current wait-state. REMOVE-SUPER-PROCEDURE( ) Method (super-proc-hdl) LOGICAL Dissociates a super procedure file from the current Progress session. SET-NUMERIC-FORMAT( ) Method ( separator , decimal-point ) LOGICAL Sets the NUMERIC-SEPARATOR and NUMERIC-DECIMAL-
POINT attributes simultaneously. SET-WAIT-STATE( ) Method
( state ) LOGICAL Sets the type of wait state, GENERAL, COMPILER, or "". Use this method to prevent user and system input, and provide visual feedback during a long computation or other process. The value you pass determines the type of wait message or cursor that the windowing system displays for the user. The value""
ends the wait state.EXAMPLE
The following example uses the SESSION:IMMEDIATE-DISPLAY attribute. When dumping or loading records from the database, the procedure displays a running count of records. If IMMEDIATE-DISPLAY is false, no value is shown until all records are dumped or loaded. At that point, the total is shown. To prevent this, IMMEDIATE-DISPLAY is set to true just before the dump or load and then reset to false afterwards.
NOTES
- Several attributes of the SESSION handle control the execution of Progress code during the current Progress session. This means that the SESSION handle controls the behavior of any code that you are developing and testing, and the Progress ADE toolset. While the tools of the Progress ADE monitor and set the attributes of the SESSION handle to meet their needs, it is possible that the execution of a procedure that sets attributes of the SESSION handle may affect the display and behavior of the Progress ADE toolset.
- The FIRST-PROCEDURE and LAST-PROCEDURE attributes are set or reset when you create or delete the first or last persistent procedure in a session. You can use procedure attributes to navigate the procedure entries, reference information, and manage the user interface for each persistent procedure in the procedure chain accessed by FIRST-PROCEDURE and LAST-PROCEDURE.
For more information on the attributes of procedure handles, see the THIS-PROCEDURE System Handle reference entry. For information on creating a persistent procedure, see the RUN Statement reference entry. For information on deleting a persistent procedure, see the DELETE PROCEDURE Statement reference entry.
- The FIRST-SERVER and LAST-SERVER attributes are set or reset when you create or delete the first or last server handle in a session. You can use server handle attributes and methods to navigate the current chain of server handles, connect to a running AppServer, reference information on a connected AppServer, access remote persistent procedures running on a connected AppServer, and disconnect from a connected AppServer for each server handle in the chain accessed by FIRST-SERVER and LAST-SERVER.
For more information on the attributes and methods of server handles, see the Server Object Handle reference entry. For information on creating server handles, see the CREATE SERVER Statement reference entry.
- Setting the IMMEDIATE-DISPLAY attribute to TRUE can significantly slow performance. However, some code segments may not execute properly with IMMEDIATE-DISPLAY set to FALSE. If a segment of code requires that IMMEDIATE-DISPLAY is TRUE, you should set the attribute to TRUE immediately before the code segment and change it back to FALSE immediately after the segment.
- On Windows, when execution is blocked for input (by a WAIT-FOR statement, for example), Progress listens for messages from the windowing system. This allows Progress to multitask properly with other Windows applications. However, if your Progress application performs long processing without blocking for input, then it may not multitask properly because Progress does not automatically check for messages from the windowing system. To force Progress to poll for windowing system messages during this time, you can set the MULTITASKING-INTERVAL attribute to a non-zero value. The lower the value, the more often Progress checks for messages. This may decrease Progress performance. The maximum value is 9999. A value of 0 inhibits polling until Progress blocks for input.
If you set MULTITASKING-INTERVAL to a non-zero value for a code segment, reset it to 0 immediately after that code.
- Progress sets the TEMP-DIRECTORY attribute to the value you specify for the Temporary Directory (-T) parameter. If you omit the -T parameter, TEMP-DIRECTORY is set to your current working directory.
- The TYPE attribute returns the widget type, PSEUDO-WIDGET.
- Use the SET-WAIT-STATE method to prevent user and system input, and provide visual feedback during a long computation or other background process. The value you pass determines the type of wait message or cursor the windowing system displays for the user. Passing the value
""
to SET-WAIT-STATE ends the wait state. Use this method only for long computations or other processes that force the user to wait significantly longer than the usual response time.- If you set a wait state for your application, Progress automatically ends the wait state if it displays an alert box, a dialog box, or message update.
- For SpeedScript, the invalid attributes are: APPL-ALERT-BOXES, CONTEXT-HELP-FILE, DATA-ENTRY-RETURN, FIRST-CHILD, HEIGHT-PIXELS, LAST-CHILD, PARAMETER, PIXELS-PER-COLUMN, PIXELS-PER-ROW, SUPPRESS-WARNINGS, SYSTEM-ALERT-BOXES, THREE-D, TOOLTIPS, V6DISPLAY, WIDTH-PIXELS. The GET-PRINTERS( ) method is invalid for SpeedScript.
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |