Sal

PPJ.Runtime.Sal

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.49 (4.9.0.0)

Contains all Sal.* static functions.

public class Sal

Public Class Sal

Properties

ScriptEngine: Returns the instance of the interpreter used by SalCompileAndEvaluate.

Type: Returns/Sets the type of the ISalReport implementation.

Methods

Halts processing of the current menu action, message action, or application action.

Returns: SalBoolean. AbortException

Use this function when you want to terminate the current calling sequence without returning a status. For example, if your application is several layers into internal function calls and an error occurs, this will terminate the current calling sequence of functions and leaves the application in the state it was prior to the first function call of that sequence.

Turns on/off automatic COM error handling.

Returns: SalBoolean.

Perform one of the object's enumerated actions.

Returns: SalBoolean.

Returns the COM object for the specified AX control.

Returns: SalBoolean.

Disables input to all open forms.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Use AppDisable and AppEnable when there are multiple applications running simultaneously and you want to control which application receives user input.

Enables input to all open forms that were disabled.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Use AppDisable and AppEnable when there are multiple applications running simultaneously and you want to control which application receives user input.

Finds a visible top-level window.

Returns: SalWindowHandle. the window

If you specify the calling application's name in AppFind(), it can only find another running instance of it. You can use this feature to prevent more than one instance of an application running. If there are multiple instances of a single application, AppFind finds and returns the window handle of the first instance it finds If an application has multiple top-level windows, AppFind returns the handle of the first top-level window it finds. Calling AppFind() multiple times does not always return the handle of the same window. If an application does not have visible windows, then AppFind() cannot find it.

Returns the average value of all the numbers in an array.

Returns: SalNumber. the average value in an array of numbers.

Returns: SalBoolean.

Determines if a dynamic array contains data.

Returns: SalBoolean. true if the array contains no data and false if it is has data.

Returns the maximum value in an array of numbers.

Returns: SalNumber. the maximum value in an array of numbers.

Returns the minimum value in an array of numbers.

Returns: SalNumber. the minimum value in an array of numbers.

Returns: SalNumber.

Sets the lower and upper bound of an array for the first dimension only. NOTE: In SAL this function was named SalSetArrayBounds().

Returns: SalBoolean. bOk

Sets the upper bound of an array. The first dimension is 1.

Returns: SalBoolean. true if the function succeeds and false if it fails.

When you call this function for a dimension other than the first, most of the array's data must be copied. There can be a performance cost when you call this function for any dimension but the first one.

Returns the sum of the elements in an array of numbers.

Returns: SalNumber. the sum of the elements in an array of numbers.

Brings a window to the top of all overlapping windows.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Clears the value from a data field, multi line field, or table window column.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Composes a color from red, green, and blue values.

Returns: SalNumber. the color created.

Gets a window's color.

Returns: SalNumber. the color

If you specify COLOR_IndexTransparent in the second parameter and the transparent color is not set, ColorGet() returns COLOR_None.

Gets a system color.

Returns: SalNumber. the color

Sets a window's color.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns: SalBoolean.

Returns: SalNumber.

Returns: SalString.

Returns an instance of SalStringContext wrapping the current context reference.

Returns: SalStringContext.

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Returns: SalBoolean. true if this function succeeds and false otherwise.

For some windows, this function also affects how the window processes a right mouse button click: List box-Right click selects the line under the cursor.If the line is already selected, there is no effect. Combo box-For a combo box where the list is always displayed, the behavior is the same as for a list box. Table window-Right click selects the row under the cursor. If the row is already selected there is no effect.

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Returns: SalBoolean. true if this function succeeds and false otherwise.

Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.

Returns: SalWindowHandle. the new window.

If you specify a parent, the new window always displays on top of its parent, closes when its parent closes, and hides when its parent is minimized. CreateWindow can pass data to and from the window being created by accepting a variable number of parameters. The data types of these parameters must match the parameter data types of the window being created. You can use window parameters to return information from the window being created by using a reference.

Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.

Returns: SalWindowHandle. the new window.

Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.

Returns: SalWindowHandle. the new window.

Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.

Returns: SalWindowHandle. the new window.

If you specify a parent, the new window always displays on top of its parent, closes when its parent closes, and hides when its parent is minimized. CreateWindowEx can pass data to and from the window being created by accepting a variable number of parameters. The data types of these parameters must match the parameter data types of the window being created. You can use window parameters to return information from the window being created by using a reference.

Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.

Returns: SalWindowHandle. the new window.

If you specify a parent, the new window always displays on top of its parent, closes when its parent closes, and hides when its parent is minimized. CreateWindowExFromStr can pass data to and from the window being created by accepting a variable number of parameters. The data types of these parameters must match the parameter data types of the window being created. You can use window parameters to return information from the window being created by using a reference.

Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.

Returns: SalWindowHandle. the new window.

Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.

Returns: SalWindowHandle. the new window.

If you specify a parent, the new window always displays on top of its parent, closes when its parent closes, and hides when its parent is minimized. CreateWindowFromStr can pass data to and from the window being created by accepting a variable number of parameters. The data types of these parameters must match the parameter data types of the window being created. You can use window parameters to return information from the window being created by using a reference.

Clears a window's cursor.

Returns: SalBoolean.

Sets a window's cursor.

Returns: SalBoolean.

Sets a window's cursor.

Returns: SalBoolean.

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

Returns: SalBoolean.

Sets a window's cursor from a string variable.

Returns: SalBoolean.

Returns the date/time constructed from the parameters year, nMonth, nDay, nHour, minute, and nSecond.

Returns: SalDateTime.

Returns the PC's current date/time.

Returns: SalDateTime.

Returns the day portion (1 to 31) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the hour portion (0 to 23) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the minute portion (0 to 59) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the month portion (1 to 12) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the date of the first day of the month or it returns DATETIME_Null if the value you specify is null. For example, if dateTime is December 25, 1992, SalDateMonthBegin returns December 1, 1992.

Returns: SalDateTime.

Returns the quarter of the year (1 to 4) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the date of the first day of the quarter of a date/time value or it returns DATETIME_Null if the value you specify is null.

Returns: SalDateTime.

Returns the seconds portion (0 to 59) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the date of the previous Monday or the current day if it is a Monday or it returns DATETIME_Null if the value you specify is null.

Returns: SalDateTime.

Returns the day of the week as a number between 0 and 6 or returns -1 if you specify DATETIME_Null as a parameter. 0 represents Saturday, 1 represents Sunday, and so on.

Returns: SalNumber.

Returns the year portion of a date or returns -1 if you specify DATETIME_Null as a parameter.

Returns: SalNumber.

Returns the date of the first day of the year or it returns DATETIME_Null if the value you specify is null.

Returns: SalDateTime.

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window. The label control must have a mnemonic. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns: SalBoolean.

Causes a dialog box to dock or undock with a parent window.

Returns: SalBoolean. true if the function succeeds and false if an error occurs. Possible error conditions include: Dialog box was created without a parent; dialog box was created with "Docking Enabled" attribute=No; the parent window does not permit docking, or does not permit docking with the orientation used in the function call; the dialog box is modal; the window handle used in the first parameter is not a dialog box.

Not implemented- always returns false Possible values for orientation: DOCK_Top The dialog is docked at top edge of the parent window. DOCK_Left The dialog is docked at left edge of the parent window. DOCK_Bottom The dialog is docked at bottom edge of the parent window. DOCK_Right The dialog is docked at right edge of the parent window. DOCK_None The dialog box is not docked (it is free-floating). DOCK_Any The dialog is docked at any of the four edges of the parent window.

Disables dropping while in drag mode.

Returns: SalBoolean.

Enables dropping while in drag mode.

Returns: SalBoolean.

Initiates drag mode.

Returns: SalBoolean.

Ends drag mode.

Returns: SalBoolean.

Redraws the menu bar for a given form window or top-level table window. Call this function to cause top-level menu items to be enabled or disabled.

Returns: SalBoolean. true if the function succeeds and false if it fails.

For a top-level menu item or pop-up menu, an Enabled when variable is only evaluated when you call SalDrawMenuBar or when the menu bar is redrawn for other reasons.

Indicates whether a window can accept a file from Windows' File Manager.

Returns: SalBoolean. true if the function succeeds and false if it fails.

The default for editable pictures is true; the default for all other window types is false.

Retrieves the names of the files dropped on a window. Receipt of the SAM_DropFiles message indicates that the user dropped files onto the window.

Returns: SalNumber. the number of dropped files if the function succeeds and zero (0) if the function fails.

DropFilesQueryFiles fails unless it is called as the result of receiving the SAM_DropFiles message.

Returns: SalBoolean.

Indicates whether you can copy from the currently selected control on the clipboard.

Returns: SalBoolean. bOk

Returns: SalBoolean.

Indicates whether you can cut from the currently selected control on the clipboard.

Returns: SalBoolean. true if data is selected and false otherwise

This function returns true if the data in a data field, multi-line field, table window column, or editable picture is selected.

Returns true if there is data on the Clipboard that can be pasted into the currently selected control

Returns: SalBoolean. true if there is data on the Clipboard to be pasted and false otherwise.

Returns: SalBoolean.

Returns true if the if there is any editing of the currently selected control that can be undone.

Returns: SalBoolean. true if there is any editing to undo and false otherwise.

Deletes selected data from the currently selected control

Returns: SalBoolean. true if the function succeeds and false if it fails.

Copies selected data from the currently selected control and puts it on the Clipboard.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Copies a string to the Clipboard as text.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns: SalBoolean.

Cuts selected data from the currently selected control and puts it on the Clipboard.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Pastes data from the Clipboard into the currently selected control

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns: SalBoolean.

Undoes the last edit to the currently selected control

Returns: SalBoolean. true if the function succeeds and false if it fails.

Editing that you can undo includes inserting text, cutting text, clearing text, and pasting text.

Enables keyboard and mouse input to a window.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Destroys a modal dialog box and returns control to the caller of ModalDialog.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Stops tracing.

Returns: SalBoolean.

Copies the contents of one file (source) to another file (destination).

Returns: SalNumber. One of the following values: FILE_CopyDest, FILE_CopyExist, FILE_CopyOK, FILE_CopyRead, FILE_CopySrc, FILE_CopyWrite.

Creates a directory.

Returns: SalBoolean. true if the function succeeds and false if a directory or file with the specified name already exists, or if the specified path to the directory cannot be found.

Returns: SalBoolean.

Returns the next character in an open file.

Returns: SalNumber. the next character in an open file.

Returns: SalBoolean.

Gets the letter of the default (current) disk drive.

Returns: SalString. A string identifying the current disk drive. The first character is a letter between 'A' and 'Z', and the second character is a colon(:).

Returns: SalBoolean.

Writes a character to an open file.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Writes a string to an open file and appends a carriage return/line feed character to the string.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns: SalNumber.

Deletes a directory.

Returns: SalBoolean. true if the function succeeds and false if it fails. FileRemoveDirectory also returns false if directory contains files or other directories.

Positions the file pointer in an open file. The next file operation (such as a read or write) takes place at this new location.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Changes the current working directory. If the specified path does not contain a drive letter, the default drive's current directory is changed. Otherwise, the specified drive's current directory is changed and the specified drive is made the current drive.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Sets the modification date and time of the specified file.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Sets the current disk drive to the specified drive letter.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Returns the current position in an open file.

Returns: SalNumber. the current position (in bytes) in file. If an error occurs, returns -1.

Writes a string to an open file.

Returns: SalNumber. the number of bytes written.

Writes a binary buffer to an open file.

Returns: SalNumber. the number of bytes written.

This function finds a child window of a given name in the specified window.

Returns: SalWindowHandle. The window handle of the window found. hWndNULL is returned if the window is not found.

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

Returns: SalNumber.

Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.

Returns: SalBoolean.

Copies the specified profile to the custom profile for the specified field. The control must use the customized profile set using FMT_Profile_Program.

Returns: SalBoolean.

Formats a date/time value using a given date/time picture format. If you do not specify a picture format or the one you specify is invalid, the default local settings are used

Returns: SalString. the formatted date/time string.

Formats a number value using a number picture format. If you do not specify a picture format or the one you specify is invalid, the default local settings are used

Returns: SalString. a formatted number string.

Returns the current format of a data field or table window column.

Returns: SalNumber. a number that indicates the format of the field.

The return value is one of the following constants: Date fields can be formatted as: FMT_Format_Date, FMT_Format_DateTime, FMT_Format_Picture, FMT_Format_Time, and FMT_Format_Unformatted. Number fields can be formatted as: FMT_Format_Currency, FMT_Format_Decimal, FMT_Format_Percentage, FMT_Format_Picture, and FMT_Format_Unformatted. String fields can be: FMT_Format_Invisible, FMT_Format_LowerCase, FMT_Format_UpperCase, and FMT_Format_Unformatted.

Returns: SalBoolean.

Returns the culture profile for the specified field.

Returns: SalNumber.

Validates the contents of a data field or table window column using the current profile.

Returns: SalBoolean. true if the field's contents are valid and false if the field's contents are invalid.

Strips off formatting characters and validates a field's contents according to type. After that, validates extra picture formatting characters that you enter to ensure that they conform to the profile requirements.

Validates the input mask of a data field or table window column.

Returns: SalBoolean. true if mask is a valid input mask and false if it is not valid.

Validates a numeric or date/time picture format.

Returns: SalBoolean. true if the picture format is valid and false otherwise.

These are examples of date/time picture formats: |

Turns on/off the flag that indicates whether to keep the mask when reading the text from masked edit controls.

Returns: SalBoolean. the value that you specified in keep.

By default, input mask characters are removed when you copy the value in a data field, table window column, or combo box. For example, if you create a data field with the input mask AA-AA and copy its value to another data field, the hyphen is not copied. You can call FmtKeepMask to change the default behavior so that the input mask characters are kept when you copy the value in a data field, table window column, or combo box. For example, if you create a data field with the input mask AA-AA and copy its value to another data field, the hyphen would be copied. The "^" character in an input mask overrides a setting that you make with this function.

Sets a data field's or table window column's format.

Returns: SalBoolean. the format for ctrl.

A field's country profile determines a format's characteristics. A field's format must agree with the field's data type, so for example, number fields can only be formatted as decimal, percentage, or currency values.

Sets the input mask of a data field or table window column.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Modifies the specified formatting rule on the control. The control must use the customized profile set using FMT_Profile_Program.

Returns: SalBoolean.

Modifies the specified formatting rule on the control. The control must use the customized profile set using FMT_Profile_Program.

Returns: SalBoolean.

Sets the picture format of a data field, table window column or date time picker.

Returns: SalBoolean. true if the function succeeds and false if it fails. Returns false if any of the following are true: The window handle is not valid. The field/column is not of date/time or number data type.The picture format is not valid.

Changes the culture profile for the specified field.

Returns: SalBoolean.

Copies a string to a data field or table window column. After copying the string to the field, formats the string.

Returns: SalBoolean. true if the string's value has the same format as the data field or table window column. Returns false if the string's value is unformatted.

Returns: SalBoolean.

Validates and formats a data field's or table window column's contents.

Returns: SalBoolean. true if the function succeeds and false otherwise, such as when the input is invalid. If it returns false, optionally displays an error dialog box.

Strips off formatting characters and validates a field's contents according to type. After that, validates picture formatting characters that you enter to ensure that they conform to the profile requirements. For dates, you must enter the proper separator characters in order for the field to be validated successfully.

Returns: SalBoolean.

Gets the names of the fonts.

Returns: SalNumber. the number of font names returned.

Returns: SalNumber.

Sets a window's font, font size, and font enhancements.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Font Enhancement Flags: FONT_EnhBold FONT_EnhDefault FONT_EnhItalic FONT_EnhNormal FONT_EnhStrikeOut FONT_EnhUnderline

Returns: SalBoolean.

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

Returns: SalNumber. the number of pixels if the function succeeds. Returns zero (0) if ctrl is invalid.

Returns the current buffer length of a binary variable.

Returns: SalNumber. The number of bytes used.

Returns the current buffer length of a string.

Returns: SalNumber. The number of bytes used.

Returns a data field's or table window column's data type.

Returns: SalNumber. a number that indicates the data field's or table window column's data type. Its value is one of a predetermined set of constants: DT_DateTime DT_LongString DT_Number DT_String

Use this function with internal functions that handle data fields and table window columns generically. Such internal functions pass only a window handle; the internal function does not know the data type of the associated window.

Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.

Returns: SalWindowHandle. the handle of the default push button. It equals hWndNULLif hWndParent is not the handle of a valid form window or dialog box, or if the window associated with hWndParent does not have a default push button.

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

Returns: SalWindowHandle. the first child window of the specified type. Returns hWndNULL if there is no child window or if hWndParent is invalid.

Window types: TYPE_AccFrame TYPE_Any TYPE_BkgdText TYPE_CheckBox TYPE_ChildGrid TYPE_ChildTable TYPE_ComboBox TYPE_CustControl TYPE_DataField TYPE_DatePicker TYPE_DateTimePicker TYPE_DialogBox TYPE_FormToolBar TYPE_FormWindow TYPE_Frame TYPE_GridWindow TYPE_GroupBox TYPE_HorizScrollBar TYPE_Line TYPE_ListBox TYPE_MDIWindow TYPE_MultilineText TYPE_OptButton TYPE_Picture TYPE_PushButton TYPE_RadioButton TYPE_TabBar TYPE_TableColumn TYPE_TableWindow TYPE_VertScrollBar TYPE_Line and TYPE_Frame are statistics by default and not implemented as windows. If you want this function to work for lines and frames set the system variable bStaticsAsWindows to TRUE. This is a global system variable, so the setting persists until it is changed.

Returns the handle of the window with the focus.

Returns: SalWindowHandle. windowFocus which identifies the window that can currently receive input from the keyboard.

Returns: SalBoolean.

Returns the maximum length of a data field, multi line text field, or table window column.

Returns: SalNumber. a number that specifies the maximum length of ctrl. A length of DW_Default (-1) indicates that the object was declared with a length of 'Default'.

Note: This function returns 0 (zero) for a table window column that is dynamically created using either TblCreateColumn or TblCreateColumnEx.

Returns the handle of the next child window that matches a specified type.

Returns: SalWindowHandle. the next child window of the specified type. Returns hWndNULL if there is no child window or if hWndChild is invalid.

Window types: TYPE_AccFrame TYPE_Any TYPE_BkgdText TYPE_CheckBox TYPE_ChildGrid TYPE_ChildTable TYPE_ComboBox TYPE_CustControl TYPE_DataField TYPE_DatePicker TYPE_DateTimePicker TYPE_DialogBox TYPE_FormToolBar TYPE_FormWindow TYPE_Frame TYPE_GridWindow TYPE_GroupBox TYPE_HorizScrollBar TYPE_Line TYPE_ListBox TYPE_MDIWindow TYPE_MultilineText TYPE_OptButton TYPE_Picture TYPE_PushButton TYPE_RadioButton TYPE_TabBar TYPE_TableColumn TYPE_TableWindow TYPE_VertScrollBar Use this function after calling GetFirstChild to get the other child window siblings. You can use this function to get the handles of MDI child windows. If you want this function to work for lines and frames, set the system variable bStaticsAsWindows to true. This is a global system variable, so the setting persists until you change it.

Retrieves the integer value of an entry in the specified section of an initialization file or registry.

Returns: SalNumber. the integer value of an entry in the specified section of a file or registry, if the function is successful. Returns zero if the value found is not an integer. Returns the default value of the entry if GetProfileInt() cannot find the specified entry.

Returns: SalNumber.

Returns the instance of ISalReport that is identified by the handle.

Returns: ISalReport.

Returns the version of the library.

Returns: SalNumber. The version number.

Retrieves the window handle of the label (label control) that is associated with the windowTarget parameter. There must be a mnemonic in that label, and it must immediately precede windowTarget, or this function will fail.

Returns: SalWindowHandle.

Returns: SalNumber.

Returns: SalBoolean.

Returns a window's current state.

Returns: SalNumber. a constant that indicates a window's current state. It is equal to one of a predefined set of values (Window_Invalid Window_Maximized Window_Minimized Window_Normal Window_NotVisible).

Returns: SalNumber.

Hides a window.

Returns: SalBoolean. true if the function succeeds and false if it fails.

This function does not destroy the window; it only makes the window invisible.

Hides a window and its associated label.

Returns: SalBoolean. true if the previous state of the window was visible and false if it was hidden. Use this information to hide many windows without first checking that they are visible. When you restore them to their original state at a later point in time, the return lets you make visible only those windows that were previously visible.

A label is the background text that immediately precedes the window in the outline. This function does not destroy the window; it only makes the window invisible.

Converts a string to a number so you can pass it as a message parameter.

Returns: SalNumber. a number that represents the converted string handle.

NOTE: Use this function only for strings to be passed as parameters with messages posted using SendMsg. Do not use this function for strings passed as parameters in messages posted using PostMsg.

Simulates an idle state.

Returns: SalBoolean. true if this function succeeds and false otherwise.

Once an idle state is detected, it does not detect another idle state until some messages have appeared in the message queue. Call IdleKick when you want idle processing to occur even though no messages have been posted. The function is rarely used because idle processing is most often used to detect user input.Since user input causes messages to be posted, an idle state is detected automatically.Usually this function is used when idle processing is needed after another program or a DLL sends a notification message.

Sends a message to a specified window whenever an idle state is detected. An idle state is detected when a window has processed all the messages in its input queue.

Returns: SalBoolean. true if this function succeeds and false otherwise.

Stops sending idle messages to a control for which you had previously called IdleRegisterWindow

Returns: SalBoolean. true if this function succeeds and false otherwise.

Causes a window to be repainted.

Returns: SalBoolean. true if this function succeeds and false otherwise.

Determines whether a radio button is set or a check box is checked.

Returns: SalBoolean. true if ctrl is set or checked and false otherwise.

Verifies whether a data field, multi line text field, or table window column is null. or empty.

Returns: SalBoolean. true if ctrl is null or empty, and false otherwise.

Verifies whether a data field, multi line text field, or table window column contains a valid date/time value. For multi line text fields, the date/time value must be the only item in the field.

Returns: SalBoolean. true if ctrl contains a valid date/time value and false otherwise.

Verifies whether a data field, multi line text field, or table window column contains a valid decimal value. For multi line text fields, the decimal value must be the only item in the field.

Returns: SalBoolean. true if ctrl contains a number of the specified precision and scale, and false if ctrl's value does not match the parameter specifications.

Verifies whether a data field, multi line text field, or table window column contains a valid integer value. For multi line text fields, the integer value must be the only item in the field.

Returns: SalBoolean. true if ctrl contains a valid integer value and false if the number is a fraction, decimal, or any other invalid integer value.

Verifies whether a data field, multi line text field, or table window column contains a valid numeric value. Valid numbers are integers or floating point numbers, negative and positive. For multi line text fields, the numeric value must be the only item in the field.

Returns: SalBoolean. true if ctrl contains a valid number and false otherwise

Determines whether a window is enabled for mouse and keyboard input.

Returns: SalBoolean. true if ctrl is enabled and false if ctrl is not enabled or is not a valid handle.

Determines whether a window is currently visible.

Returns: SalBoolean. true if the window is visible and false otherwise.

Adds a string to a list box or combo box.

Returns: SalNumber. Index of the added item. Returns LB_Erron an error and LB_ErrSpace if there is insufficient memory to store the new string.

If the list box is sorted (the default), inserts the string into the list in the appropriate place. If the list box is not sorted, adds the string to the end of the list box. Uses ANSI ascending order in the sort.

Deletes all entries from a list box or combo box.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Deletes a list box or combo box entry.

Returns: SalNumber. the number of rows remaining in the list box or combo box if the function succeeds. Returns LB_Err if an error occurs.

Returns: SalBoolean.

Returns an array of index numbers of selected list box entries.

Returns: SalBoolean. True if at least 1 item selected, otherwise false.

Use the ListQueryMultiCount function to return the number of selected list box entries.

Inserts an entry into a list box or combo box at a specified position.

Returns: SalNumber. the index of the new entry. Returns LB_Err on an error and LB_ErrSpace if there is insufficient memory to store the new string.

Populates a list box or combo box with a result set. ListPopulate overrides any settings made with ListSetTabs. If the SELECT statement returns data from multiple columns, each column's data displayed in a list box is separated by tabs.

Returns: SalBoolean. true if the function succeeds and false if any of the parameters are invalid or if select contains INTO variables.

The SELECT statement can contain bind variables, but it cannot contain INTO variables. If select is null (''), uses the previously prepared SELECT statement associated with sql This avoids re-preparing each time ListPopulate executes.

Populates a list box or combo box with a result set. If the SELECT statement returns data from multiple columns, each column's data displayed in the list box is separated by tabs.

Returns: SalBoolean. true if the function succeeds and false if any of the parameters are invalid or if select contains INTO variables.

Returns the number of list box or combo box entries.

Returns: SalNumber. Number of items in the list.

Returns: SalBoolean.

Returns the number of selected entries in a multiple-selection list box. Specify single-selection or multiple-selection in the list box's customizer.

Returns: SalNumber. Number of selected items.

Returns the index of the selected entry in a combo box or single-selection list box.

Returns: SalNumber. Index of the currently selected item in the list, or -1 for no selection.

Determines whether the specified list box or combo box entry is selected.

Returns: SalBoolean. True is the specified item is selected.

Returns: SalNumber.

Returns the length of a list box or combo box entry.

Returns: SalNumber. Length of the text of the specified item.

Returns the text of the specified item.

Returns: SalString. Text of the specified item.

Redraws entries in a list box or combo box, or prevents them from being redrawn.

Returns: SalBoolean. true if the function succeeds and false otherwise, such as when ctrl is not valid.

Finds and selects a combo box or single-selection list box entry.

Returns: SalNumber. Index of the first item that matches the text or -1 if not found.

Selects or deselects a combo box or multiple-selection list box entry.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Selects or deselects a combo box or single-selection list box entry.

Returns: SalBoolean. true if the function succeeds and false if it fails. Returns LB_Err if an error occurs.

Sets tabs in a list box.

Returns: SalBoolean. true if the function succeeds and false if it fails.

List boxes use tabs to align columns of data. You need to set tabs when you are using a proportional font. Note: Since SalListPopulate overrides any settings made with SalListSetTabs, call SalListSetTabs (to set tabs) after you populate a list box using SalListPopulate.Note that you can use SalListSetTabs (to set tab stops) after you populate using SalListPopulate.

Starts an application.

Returns: SalBoolean. true if the function succeeds. false if the application cannot be found or started.

You can start another application by calling LoadApp(). You can use LoadApp() to pass command line arguments from one application to another.

Returns: SalBoolean.

Appends the string to the file.

Returns: SalBoolean.

Appends the string and a new line to the file.

Returns: SalBoolean.

Changes the behavior of the Enter key from executing the default button on a window to moving the focus to the next field. This function takes one parameter (true or false) to enable or disable this action.

Returns: SalBoolean. true if the function succeeds and false if you do not specify a Boolean value.

Arranges minimized child window icons in an MDI window.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Cascades all non-iconized child windows of an MDI window.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Tiles all non-iconized child windows of an MDI window. Windows that are not sizable will not be tiled.

Returns: SalBoolean. true if the function succeeds and false if it fails.

Plays a waveform sound that corresponds to a given system alert level. A user can set the sound for each alert level with the sounds application in the Control Panel.

Returns: SalBoolean. true if the function succeeds and false if it fails.

MB constants: MB_IconAsterisk MB_IconExclamation MB_IconStop MB_IconQuestion MB_Ok

Displays a message box and returns a number that indicates the user's response. You can customize the message box push buttons and icons. The active parent window creates the message box.

Returns: SalNumber. The value of the push button that the user clicks. Possible values: IDABORT IDCANCEL IDIGNORE IDNO IDOK IDRETRY IDYES

Displays a message box and returns a number that indicates the user's response. You can customize the message box push buttons and icons. The active parent window creates the message box.

Returns: SalNumber. The value of the push button that the user clicks. Possible values: IDABORT IDCANCEL IDIGNORE IDNO IDOK IDRETRY IDYES

A style has four components: Push buttons: MB_AbortRetryIgnore MB_Ok (default) MB_OkCancel MB_RetryCancel MB_YesNo MB_YesNoCancel Message icons, if any: MB_IconAsterisk MB_IconExclamation MB_IconHand MB_IconQuestion MB_IconStop A default button: MB_DefButton1 MB_DefButton2 MB_DefButton3 MB_NoFocus Whether the message box is system modal: MB_ApplModal (default) or MB_SystemModal

Displays a message box and returns a number that indicates the user's response. You can customize the message box push buttons and icons.

Returns: SalNumber. The value of the push button the user clicks.

Creates a modal dialog box.

Returns: SalNumber. the value specified in the second parameter of EndDialog. Returns -1 if the dialog box is not created.

A modal dialog box suspends the application until the user closes the dialog box. EndDialog destroys the modal dialog box and enables all windows that were disabled. ModalDialog() can pass information to the dialog box by accepting a variable number of parameters. The data types of these parameters must match the parameter data types of the dialog box being created. You define parameters for the dialog box in the Window Parameters section of the application outline. You can use window parameters to return information from the window being created by using a reference type. Note: Attempting to use the return value from this function to set a Window Handle variable will result in a compile error when compiling to a.NET build target.This function returns a number, not a window handle.

Creates a modal dialog box.

Returns: SalNumber. the value specified in the second parameter of EndDialog. Returns -1 if the dialog box is not created.

Creates a modal dialog box.

Returns: SalNumber. the value specified in the second parameter of EndDialog. Returns -1 if the dialog box is not created.

Creates a modal dialog box.

Returns: SalNumber. the value specified in the second parameter of EndDialog. Returns -1 if the dialog box is not created.

Moves a window a given number of form units on the X and Y axes relative to its current position.

Returns: SalBoolean. true if the function succeeds, and false if ctrl is invalid.

Returns: SalBoolean.

Indicates that the object's transactional updates cannot be committed in the present time until SalMTSEnableCommit() or SalMTSSetComplete() is called. For non-MTS components the SalMTSDisableCommit() will fail (returns FALSE).

Returns: SalBoolean. true if successful, returns false if it fails.

Indicates that the object’s work is not necessarily done, but that its transactional updates can be committed in their current form (stateful object). EnableCommit is the default state when an object is activated. For non-MTS components the SalMTSEnableCommit() will fail (returns FALSE).

Returns: SalBoolean. true if successful, returns false if it fails.

Returns: SalBoolean.

Indicates that the object’s work can never be committed. The entire transaction is aborted. The object is deactivated upon return from the method. For non-MTS components the SalMTSSetAbort() will fail (returnS FALSE).

Returns: SalBoolean. true if successful, returns false if it fails.

Indicates that the object has successfully completed its work for the transaction. The object is deactivated upon return from the method that first entered the context (stateless object). For non-MTS components the SalMTSSetComplete() will fail (returns FALSE).

Returns: SalBoolean. true if successful, returns false if it fails.

Adds a new group to the specified pane of a navigation bar.