The Sal type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | Abort |
Halts processing of the current menu action, message action, or application action.
|
| ActiveXAutoErrorMode |
Turns on/off automatic COM error handling.
|
| ActiveXDoVerb |
Perform one of the object's enumerated actions.
|
| ActiveXGetObject |
Returns the COM object for the specified AX control.
|
| AppDisable |
Disables input to all open forms.
|
| AppEnable |
Enables input to all open forms that were disabled.
|
| AppFind |
Finds a visible top-level window.
|
| ArrayAvg |
Returns the average value of all the numbers in an array.
|
| ArrayDimCount |
Returns the number of dimensions in an array.
|
| ArrayGetLowerBound |
Returns the lower bound of the array.
|
| ArrayGetUpperBound |
Returns the upper bound of an array.
|
| ArrayIsEmpty |
Determines if a dynamic array contains data.
|
| ArrayMax |
Returns the maximum value in an array of numbers.
|
| ArrayMin |
Returns the minimum value in an array of numbers.
|
| ArrayQueryBounds |
Reurns the lower and upper bound of an array.
If the array empty, it returns FALSE.
NOTE: In SAL this function was named SalQueryArrayBounds().
|
| ArraySetBounds |
Sets the lower and upper bound of an array for the first dimension only.
NOTE: In SAL this function was named SalSetArrayBounds().
|
| ArraySetUpperBound |
Sets the upper bound of an array.
The first dimension is 1.
|
| ArraySum |
Returns the sum of the elements in an array of numbers.
|
| BringWindowToTop |
Brings a window to the top of all overlapping windows.
|
| CenterWindow |
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.
|
| ClearField |
Clears the value from a data field, multiline field, or table window column.
|
| ColorFromRGB |
Composes a color from red, green, and blue values.
|
| ColorGet |
Gets a window's color.
|
| ColorGetSysColor |
Gets a system color.
|
| ColorSet |
Sets a window's color.
|
| ColorToRGB(Color, SalNumber%, SalNumber%, SalNumber%) |
Decomposes a color into red, green, and blue values.
|
| ColorToRGB(SalNumber, SalNumber%, SalNumber%, SalNumber%) |
Decomposes a color into red, green, and blue values.
|
| CompileAndEvaluate |
Evaluates an expression and returns the expression's value in the receive parameter
appropriate to its data type.
|
| ContextBreak | Obsolete.
Not supported.
|
| ContextCurrent |
Returns an instance of SalStringContext wrapping the current context reference.
|
| ContextMenuSetPopup(Control, SalString, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| ContextMenuSetPopup(Control, Type, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| CreateWindow(SalString, Control) |
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows
at runtime.
|
| CreateWindow(Type, Control, array<Object>[]()[][]) |
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows
at runtime.
|
| CreateWindow(SalString, Control, array<Object>[]()[][]) |
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows
at runtime.
|
| CreateWindowEx(SalString, Control, SalNumber, SalNumber, SalNumber, SalNumber, SalNumber) |
Creates a form window, dialog box, or table window as a child of another form window,
dialog box, or toolbar at runtime.
|
| CreateWindowEx(Type, Control, SalNumber, SalNumber, SalNumber, SalNumber, SalNumber, array<Object>[]()[][]) |
Creates a form window, dialog box, or table window as a child of another form window,
|
| CreateWindowExFromStr |
Creates a form window, dialog box, or table window as a child of another form window,
dialog box, or toolbar at runtime.
|
| CreateWindowFromStr |
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows
at runtime.
|
| CursorClear |
Clears a window's cursor.
|
| CursorSet(Control, SalNumber, SalNumber) |
Sets a window's cursor.
|
| CursorSet(Control, SalResourceCursor, SalNumber) |
Sets a window's cursor.
|
| CursorSetFile |
Sets an application-defined cursor for the specified window. Use this function to
set the cursor from an image stored in a file.
|
| CursorSetString |
Sets a window's cursor from a string variable.
|
| DateConstruct |
Returns the date/time constructed from the parameters nYear, nMonth, nDay, nHour,
nMinute, and nSecond.
|
| DateCurrent |
Returns the PC's current date/time.
|
| DateDay |
Returns the day portion (1 to 31) of a date/time value or returns -1 if you specify
DATETIME_Null as a parameter.
|
| DateHour |
Returns the hour portion (0 to 23) of a date/time value or returns -1 if you specify
DATETIME_Null as a parameter.
|
| DateMinute |
Returns the minute portion (0 to 59) of a date/time value or returns -1 if you specify
DATETIME_Null as a parameter.
|
| DateMonth |
Returns the month portion (1 to 12) of a date/time value or returns -1 if you specify
DATETIME_Null as a parameter.
|
| DateMonthBegin |
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.
|
| DateQuarter |
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.
|
| DateQuarterBegin |
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.
|
| DateSecond |
Returns the seconds portion (0 to 59) of a date/time value or returns -1 if you specify
DATETIME_Null as a parameter.
|
| DateToStr |
Converts a date/time value to a string value.
Returns -1 if you specify DATETIME_Null as a parameter.
|
| DateWeekBegin |
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.
|
| DateWeekday |
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.
|
| DateYear |
Returns the year portion of a date or returns -1 if you specify DATETIME_Null as
a parameter.
|
| DateYearBegin |
Returns the date of the first day of the year or it returns DATETIME_Null if the
value you specify is null.
|
| DestroyWindow |
Destroys a form window, a top-level table window, or a modeless dialog box created
with SalCreateWindow.
|
| DisableWindow |
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.
|
| DisableWindowAndLabel |
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.
|
| DlgChooseColor |
Displays the Windows Color dialog box where the user can either select an existing
color or create a new one. See the Control Panel chapter in the Microsoft Windows'
User's Guide for a detailed description of the Color dialog box.
|
| DlgChooseFont |
Displays the Windows Font dialog box.
|
| DlgGetDockStatus |
Retrieves docking information for a dialog box.
|
| DlgOpenFile |
Displays a Windows dialog box where the user can select a file to open.
|
| DlgSaveFile |
Displays a Windows dialog box where the user can save a file.
|
| DlgSetDockStatus |
Causes a dialog box to dock or undock with a parent window.
|
| DragDropDisableDrop |
Disables dropping while in drag mode.
|
| DragDropEnableDrop |
Enables dropping while in drag mode.
|
| DragDropGetSource | |
| DragDropGetTarget |
Retrieves the handle of the target window and the location
of the mouse in that window.
|
| DragDropStart |
Initiates drag mode.
|
| DragDropStop |
Ends drag mode.
|
| DrawMenuBar |
Redraws the menu bar for a given form window or top-level table window.
|
| DropFilesAcceptFiles |
Indicates whether a window can accept a file from Windows' File Manager.
|
| DropFilesQueryFiles |
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.
|
| DropFilesQueryPoint |
Finds the location of the mouse in a window at the time that the user dropped files
onto the window. Receipt of the SAM_DropFiles message indicates that the user
dropped files onto the window.
|
| EditCanCopy |
Indicates wether you can copy from the currently selected control on the clipboard.
|
| EditCanCopyTo | Obsolete.
Not Supported.
|
| EditCanCut |
Indicates wether you can cut from the currently selected control on the clipboard.
|
| EditCanPaste |
Returns TRUE if there is data on the Clipboard that can be pasted into
the currently selected control
|
| EditCanPasteFrom | Obsolete.
Not Supported.
|
| EditCanUndo |
Returns TRUE if the if there is any editing of the currently selected control
that can be undone.
|
| EditClear |
Deletes selected data from the currently selected control
|
| EditCopy |
Copies selected data from the currently selected control
and puts it on the Clipboard.
|
| EditCopyString |
Copies a string to the Clipboard as text.
|
| EditCopyTo | Obsolete.
Not Supported.
|
| EditCut |
Cuts selected data from the currently selected control
and puts it on the Clipboard.
|
| EditPaste |
Pastes data from the Clipboard into the currently selected control
|
| EditPasteFrom | Obsolete.
Not supported
|
| EditPasteString |
Pastes the contents of the Clipboard into the specified string in text format.
|
| EditUndo |
Undoes the last edit to the currently selected control
Editing that you can undo includes inserting text, cutting text, clearing
text, and pasting text.
|
| EnableWindow |
Enables keyboard and mouse input to a window.
|
| EnableWindowAndLabel |
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.
|
| EndDialog |
Destroys a modal dialog box and returns control to the caller of SalModalDialog.
|
| EndTrace |
Stops tracing.
|
| FileClose |
Closes a file.
|
| FileCopy |
Copies the contents of one file (source) to another file (destination).
|
| FileCreateDirectory |
Creates a directory.
|
| FileGetChar(SalFileHandle) |
Returns the next character in an open file.
|
| FileGetChar(SalFileHandle, SalNumber%) |
Returns the next character in an open file. You must use this function in place of
the SalFileGetChar function if the file contains non- ASCII (ANSI) or 16-bit characters.
If the character returned is a 16-bit character, the lead byte of the
character is in the high-order byte, and the trail byte is in the low- order byte.
To get the lead byte, use SalNumberHigh. To get the trail byte, use SalNumberLow.
|
| FileGetCurrentDirectory |
Gets the full path name of the current working directory.
|
| FileGetDateTime |
Gets the modification date and time of the specified file.
|
| FileGetDrive |
Gets the letter of the default (current) disk drive.
|
| FileGetStr |
Returns the next line from an open file and strips off the trailing carriage
return/line feed of the returned string.
|
| FileOpen |
Opens, re-opens, creates, or deletes a file.
|
| FileOpenExt | Obsolete.
Not supported.
|
| FilePutChar |
Writes a character to an open file.
|
| FilePutStr |
Writes a string to an open file and appends a carriage return/line feed character
to the string.
|
| FileRead |
Reads a buffer of characters from an open file to a string .
|
| FileRemoveDirectory |
Deletes a directory.
|
| FileSeek |
Positions the file pointer in an open file.
|
| FileSetCurrentDirectory |
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.
|
| FileSetDateTime |
Sets the modification date and time of the specified file.
|
| FileSetDrive |
Sets the current disk drive to the specified drive letter.
|
| FileTell |
Returns the current position in an open file.
|
| FileWrite |
Writes a string to an open file.
|
| FindWindow |
This function finds a child window of a given name in the specified window.
|
| FmtCopyProfile |
Copies the specified profile to the custom profile for the specified field.
The control must use the customized profile set using FMT_Profile_Program.
|
| FmtFieldToStr |
Copies the contents of a data field or table window column to a string. This function
also lets you copy the format of the data.
|
| FmtFormatDateTime |
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
|
| FmtFormatNumber |
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
|
| FmtGetFormat |
Returns the current format of a data field or table window column.
|
| FmtGetInputMask |
Gets the input mask of a data field or table window column.
|
| FmtGetParmNum |
Returns the requested format information.
|
| FmtGetParmStr |
Returns the requested format information.
|
| FmtGetPicture |
Gets the format of a data field or table window column.
|
| FmtGetProfile |
Returns the culture profile for the specified field.
|
| FmtIsValidField |
Validates the contents of a data field or table window column using the current profile.
|
| FmtIsValidInputMask |
Validates the input mask of a data field or table window column.
|
| FmtIsValidPicture |
Validates a numeric or date/time picture format.
|
| FmtKeepMask |
Turns on/off the flag that indicates whether to keep the
mask when reading the text from masked edit controls.
|
| FmtSetFormat |
Sets a data field's or table window column's format.
|
| FmtSetInputMask |
Sets the input mask of a data field or table window column.
|
| FmtSetParmNum |
Modifies the specified formatting rule on the control.
The control must use the customized profile set using FMT_Profile_Program.
|
| FmtSetParmStr |
Modifies the specified formatting rule on the control.
The control must use the customized profile set using FMT_Profile_Program.
|
| FmtSetPicture |
Sets the picture format of a data field or table window column.
|
| FmtSetProfile |
Changes the culture profile for the specified field.
|
| FmtStrToField |
Copies a string to a data field or table window column. After copying the string
to the field, formats the string.
|
| FmtUnmaskInput |
Unmasks the text from a masked edit control.
|
| FmtValidateField |
Validates and formats a data field's or table window column's contents.
|
| FontGet |
Gets a window's font name, size, and enhancements.
|
| FontGetNames |
Gets the names of the screen or printer fonts.
|
| FontGetSizes | Obsolete.
Not Supported.
|
| FontSet |
Sets a window's font, font size, and font enhancements.
|
| FormUnitsToPixels |
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.
|
| GetDataType |
Returns a data field's or table window column's data type.
|
| GetDefButton |
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.
|
| GetFirstChild |
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.
|
| GetFocus |
Returns the handle of the window with the focus.
|
| GetItemName |
Gets the name of an object.
|
| GetMaxDataLength |
Returns the maximum length of a data field, multiline text field, or table window
column.
|
| GetNextChild |
Returns the handle of the next child window that matches a specified type.
|
| GetProfileInt |
Retrieves the integer value of an entry in the specified section of an initialization
file or registry.
|
| GetProfileString |
Retrieves the string value of an entry in the specified section of an initialization
file or registry.
|
| GetType |
Returns an object's type.
|
| GetVersion |
Returns the version of the library.
|
| GetWindowLabel |
Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter.
There must be a mnemonic in that label, and it must immediately precede hWndTarget, or this function will fail.
|
| GetWindowLabelText |
Retrieves the text of the label associated to a control. Important: The label control does not
require a mnemonic for the functions listed above to operate.
|
| GetWindowLoc |
Returns a window's current position on the X and Y axes.
|
| GetWindowSize |
Returns a window's size.
|
| GetWindowState |
Returns a window's current state.
|
| GetWindowText |
Retrieves the text of a window.
|
| HideWindow |
Hides a window.
|
| HideWindowAndLabel |
Hides a window and its associated label.
|
| HStringToNumber |
Converts a string to a number so you can pass it as a message parameter.
|
| IdleKick |
Simulates an idle state.
|
| IdleRegisterWindow |
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.
|
| IdleUnregisterWindow |
Stops sending idle messages to a control.
|
| InvalidateWindow |
Causes a window to be repainted.
|
| IsButtonChecked |
Determines whether a radio button is set or a check box is checked.
|
| IsNull |
Verifies whether a data field, multiline text field, or table window column is null
or empty.
|
| IsValidDateTime |
Verifies whether a data field, multiline text field, or table window column contains
a valid date/time value. For multiline text fields, the date/time value must
be the only item in the field.
|
| IsValidDecimal |
Verifies whether a data field, multiline text field, or table window column contains
a valid decimal value. For multiline text fields, the decimal value must be
the only item in the field.
|
| IsValidInteger |
Verifies whether a data field, multiline text field, or table window column contains
a valid integer value. For multiline text fields, the integer value must be
the only item in the field.
|
| IsValidNumber |
Verifies whether a data field, multiline text field, or table window column contains
a valid numeric value. Valid numbers are integers or floating point numbers,
negative and positive. For multiline text fields, the numeric value must be the
only item in the field.
|
| IsWindowEnabled |
Determines whether a window is enabled for mouse and keyboard input.
|
| IsWindowVisible |
Determines whether a window is currently visible.
|
| ListAdd |
Adds a string to a list box or combo box.
|
| ListClear |
Deletes all entries from a list box or combo box.
|
| ListDelete |
Deletes a list box or combo box entry.
|
| ListFiles |
Populates a list box or combo box with a directory of files.
|
| ListGetMultiSelect |
Returns an array of index numbers of selected list box entries.
|
| ListInsert |
Inserts an entry into a list box or combo box at a specified position.
|
| ListPopulate(Control, SalSqlHandle, SalString) |
Populates a list box or combo box with a result set. SalListPopulate overrides any
settings made with SalListSetTabs. If the SELECT statement returns data from multiple
columns, each column's data displayed in a list box is separated by tabs.
|
| ListPopulate(Control, SalSqlHandle, SalString, WhenSqlErrorHandler) |
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.
|
| ListQueryCount |
Returns the number of list box or combo box entries.
|
| ListQueryFile |
Fetches the selected directory or file name from a list box or combo box.
|
| ListQueryMultiCount |
Returns the number of selected entries in a multiple-selection list box. Specify
single-selection or multiple-selection in the list box's customizer.
|
| ListQuerySelection |
Returns the index of the selected entry in a combo box or single-selection list box.
|
| ListQueryState |
Determines whether the specified list box or combo box entry is selected.
|
| ListQueryText |
Returns the text of the specified item.
|
| ListQueryTextLength |
Returns the length of a list box or combo box entry.
|
| ListQueryTextX |
Returns the text of the specified item.
|
| ListRedraw |
Redraws entries in a list box or combo box, or prevents them from being redrawn.
|
| ListSelectString |
Finds and selects a combo box or single-selection list box entry.
|
| ListSetMultiSelect |
Selects or deselects a combo box or multiple-selection list box entry.
|
| ListSetSelect |
Selects or deselects a combo box or single-selection list box entry.
|
| ListSetTabs |
Sets tabs in a list box.
|
| LoadApp |
Starts an application.
|
| LoadAppAndProcessMsgs |
Starts an application, then waits for it to exit before returning control to the original application.
However, the original application can continue to process messages.
|
| LoadAppAndWait | |
| Log |
Appends the string to the file.
|
| LogLine |
Appends the string and a new line to the file.
|
| LogResource | Obsolete.
Logs the available resources to the file.
|
| MapEnterToTab |
Changes the behavior of the Enter key from executing the default button
on a window to moving the focus to the next field.
|
| MDIArrangeIcons |
Arranges minimized child window icons in an MDI window.
|
| MDICascade |
Cascades all non-iconized child windows of an MDI window.
|
| MDITile |
Tiles all non-iconized child windows of an MDI window. Windows that are not sizable
will not be tiled.
|
| MessageBeep |
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.
|
| MessageBox(SalString) |
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,
whose value is hWndForm, creates the message box.
|
| MessageBox(SalString, SalString, SalNumber) |
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,
whose value is hWndForm, creates the message box.
|
| MessageBox(Control, SalString, SalString, SalNumber) |
Displays a message box and returns a number that indicates the user's response. You
can customize the message box push buttons and icons.
|
| ModalDialog(SalString, Control) |
Creates a modal dialog box.
|
| ModalDialog(Type, Control, array<Object>[]()[][]) |
Creates a modal dialog box.
|
| ModalDialog(SalString, Control, array<Object>[]()[][]) |
Creates a modal dialog box.
|
| ModalDialogFromStr |
Creates a modal dialog box.
|
| MoveWindow |
Moves a window a given number of form units on the X and Y axes relative to its current
position.
|
| MTSCreateInstance |
Creates a new component. Depending on the Transaction settings this component will
continue the current transaction, will start a new transaction, or will under
non-transactional state. For non-MTS components the SalMTSCreateInstance() will
work as Create().
|
| MTSDisableCommit |
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).
|
| MTSEnableCommit |
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).
|
| MTSGetObjectContext | Obsolete.
Not supported.
|
| MTSIsCallerInRole |
Determines whether the caller is in the specified role.
|
| MTSIsInTransaction |
This method checks if the component is executing in the transaction context. For
non-MTS components the SalMTSIsInTransaction() will fail (returns FALSE).
|
| MTSIsSecurityEnabled |
This method checks for the security status. If the object is running in the client's
process, there is no security checking and SalMTSIsSecurityEnabled will always
return FALSE. For non-MTS components the SalMTSIsSecurityEnabled() will fail
(returns FALSE).
|
| MTSSetAbort |
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).
|
| MTSSetComplete |
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).
|
| NumberAbs |
Computes the absolute num.
|
| NumberArcCos |
Computes the arc cosine of a num in the range 0 to 1.
|
| NumberArcSin |
Computes a num's arc sine.
|
| NumberArcTan |
Computes a num's arc tangent.
|
| NumberArcTan2 |
Computes the arc tangent of two nums. This function uses the signs of both parameters
to determine the quadrant of the return num.
|
| NumberCos |
Computes an angle's cosine.
|
| NumberCosH |
Computes an angle's hyperbolic cosine.
|
| NumberExponent |
Computes a num's exponential function.
|
| NumberHigh |
Returns a number's high-order word num (most significant 16 bits).
|
| NumberHypot |
Computes the length of the hypotenuse of a right triangle, given the lengths of the
other two sides.
|
| NumberLog |
Computes a number's natural logarithm.
|
| NumberLogBase10 |
Computes a number's base -10 logarithm.
|
| NumberLow |
Returns a number's low-order word num (least significant 16 bits).
|
| NumberMax |
Returns the greater of two numbers.
|
| NumberMin |
Returns the lesser of two numbers.
|
| NumberMod | |
| NumberPi |
Multiples a number by Pi.
|
| NumberPower |
Computes nX raised to the power of nY.
|
| NumberRandInit |
Sets the starting point for generating a series of pseudo-random numbers using SalNumberRandom.
|
| NumberRandom |
Generates a pseudo-random number. The numbers generated by this function are integers
in the range 0 to 32767.
|
| NumberRound |
Returns a rounded number. If the fractional part of a number is greater than or equal
to .5, rounds the number up. For example, the number 1.4 returns
1; the number 1.5 returns 2.
|
| NumberSin |
Computes an angle's sine.
|
| NumberSinH |
Computes an angle's hyperbolic sine.
|
| NumberSqrt |
Computes a number's square root.
|
| NumberTan |
Computes an angle's tangent.
|
| NumberTanH |
Computes an angle's hyperbolic tangent.
|
| NumberToChar |
Converts a decimal num to a UNICODE character.
|
| NumberToHString |
Converts a string handle to the corresponding string instance.
|
| NumberToStr |
Converts a number to a string.
|
| NumberToStrX |
Converts a number to a string.
|
| NumberToWindowHandle |
Converts a number to a window handle.
|
| NumberTruncate |
Truncates a number.
|
| ObjCreateFromString |
Creates an instance of the class.
|
| ObjGetType |
This function returns the name of the class for the object.
|
| ObjIsDerived |
Returns true if the object is derived from the class specified.
|
| ObjIsNull |
This function checks to see if the variable of a functional, coclass, or interface
class is null.
|
| ObjIsValidClassName |
Determine whether sClassName holds a valid user-defined class name.
|
| ParentWindow |
Returns the handle of an object's parent window.
|
| Pause |
Pauses the application for the specified number of milliseconds.
It keeps dispatching messages.
|
| PicClear |
Deletes the contents of a picture.
|
| PicGetDescription |
Retrieves a description of a picture's contents.
|
| PicGetImage |
Copies the contents of a picture to a string.
|
| PicGetString |
Copies the contents of a picture to a string.
|
| PicSet |
Inserts a resource into a picture.
|
| PicSetFile |
Inserts a file's contents into a picture.
|
| PicSetFit |
Sets the fit for a picture.
|
| PicSetHandle |
Sets the picture image of a picture window with the handle of a bitmap (HBITMAP)
or icon (HICON). Usually, HBITMAPs and HICONs are loaded from DLLs.
|
| PicSetImage |
Inserts the contents of a picture to an image without the image header.
|
| PicSetString |
Inserts the contents of a string into a picture.
|
| PixelsToFormUnits |
Computes the number of form units based on the number of pixels.
Form units are a unit of measurement used by functions that move and position objects.
Form units are computed using physical units (pixels) in conjunction
with a window's font sizes.
|
| PostMsg |
Posts the specified message to a window by adding nMsg to hWndReceiver's message
queue.
|
| PrtExtractRect |
Extracts the currently printing rectangle from the SAM_Print message's lParam parameter.
|
| PrtGetDefault |
Returns the default device (printer), the default driver, and the default port.
|
| PrtGetParmNum |
Gets the value of a print parameter.
|
| PrtPreviewForm |
Prints a form window, table window, or dialog box, including its contents and row
header flags.
|
| PrtPrintForm |
Prints a form window, table window, or dialog box, including its contents and row
header flags.
|
| PrtSetDefault |
Sets the default device (printer), driver, and port.
|
| PrtSetParmDefaults |
Resets print parameters back to their default values.
|
| PrtSetParmNum |
Sets the value of a print parameter. The print parameters are a set of global variables
which are initialized to default values and can be set using SalPrtSetParmNum,
retrieved using SalPrtGetParmNum or reinitialized using SalPrtSetParmDefaults.
|
| PrtSetup |
Displays the Printer Setup dialog box that lets the user alter the printer setup.
Initially, the current default printer is displayed and the user may change the
printer. SalPrtSetup returns the user's selections in the Receive Strings.
|
| QueryFieldEdit |
Returns the setting of the Field Edit Flag for a data field, multiline field, combo
box, table window's context row cell, or picture.
|
| Quit |
Exits an application.
|
| ReportClose |
Closes a report window.
|
| ReportCmd |
Sends a command to an open report window.
|
| ReportCreate(SalString, SalString, SalString, SalBoolean, SalNumber%) |
Creates a new report from the specified fields.
|
| ReportCreate(SalString, SalString, SalString, SalBoolean, SalNumber%, SalString) |
Creates a new report from the specified fields.
|
| ReportDlgOptions |
Sets the options for the report printing dialog box.
|
| ReportGetDateTimeVar |
Returns the value of a date/time report variable.
|
| ReportGetNumberVar |
Returns the value of a number report variable.
|
| ReportGetObjectVar |
Returns the value of an object report variable.
|
| ReportGetPrinterSettings |
Sets the printer properties at runtime.
This function should be called wile processing the SAM_ReportStart event.
|
| ReportGetStringVar |
Returns the value of a string report variable.
|
| ReportPrint |
Prints a report.
|
| ReportPrintToFile(Control, SalString, SalString, SalString, SalString, SalNumber, SalNumber, SalNumber, SalNumber%) |
Prints a report to a file.
|
| ReportPrintToFile(Control, SalString, SalString, SalString, SalString, SalNumber, SalNumber, SalNumber, SalNumber, SalBoolean, SalNumber%) |
Prints a report to a file.
|
| ReportReset |
Re-populates the report window.
|
| ReportSetDateTimeVar |
Sets the value of a date/time report variable.
|
| ReportSetNumberVar |
Sets the value of a numeric report variable.
|
| ReportSetObjectVar |
Sets the value of an object report variable.
|
| ReportSetPrinterSettings |
Sets the printer properties at runtime.
This function should be called wile processing the SAM_ReportStart event.
|
| ReportSetStringVar |
Sets the value of a string report variable.
|
| ReportTableCreate(SalString, Control, SalNumber%) |
Creates a report template from the specified table window.
|
| ReportTableCreate(SalString, Control, SalNumber%, SalString) |
Creates a report template from the specified table window.
|
| ReportTablePrint |
Prints a report created from the specified table window.
|
| ReportTableView |
Previews a report created from the specified table window.
|
| ReportView |
Displays a report in preview mode.
|
| ResolveType |
Finds the type in any loaded assembly.
The first specified assembly argument has the precedence.
|
| ScrollGetPos |
Returns the current scroll bar value.
|
| ScrollGetRange |
Gets a scroll bar's scroll range, line increment, and page increment.
|
| ScrollSetPos |
Sets the scrollbar's value.
|
| ScrollSetRange |
Sets a scroll bar's range, line increment, and page increment.
|
| SendClassMessage |
Invokes the message actions implemented or inherited by an object's class when called
from either a derived class or from an object that is an instance of a class.
|
| SendClassMessageNamed |
Invokes the message actions implemented or inherited by an object's class when called
from either a derived class or from an object that is an instance of a class.
Use this function instead of SalSendClassMessage with a class that is the result
of multiple inheritance. It lets you specify which base class message action
you want to execute.
|
| SendMsg |
Sends the specified message to a window. SalSendMsg does not return until the processing
for the message is complete.
|
| SendMsgToChildren |
Sends a message to all child items of a form window, dialog box, table window, or
MDI window.
|
| SendValidateMsg |
Sends a SAM_Validate message to the object with the focus data field, multiline field,
or table window column if it was edited and sets the wParam and LParam message
variables to zero (0).
|
| SetDefButton |
Sets the default push button of a form window or dialog box.
|
| SetErrorInfo |
Sets COM error information.
|
| SetFieldEdit |
Sets or clears the field edit flag for an editable data field, combo box, multiline
text field, table window column, or picture.
|
| SetFocus |
Sets the focus to a specified window.
|
| SetMaxDataLength |
Sets a limit on the number of characters that a user can enter into a data field,
multiline text field, or table window column.
|
| SetProfileString |
Set the value of an entry in the specified section of an initialization file or registry.
|
| SetWindowLabelText |
Sets the text of the label associated to a control. To be associated with a specific window, background
text must immediately precede the window in the Outliner. Important: The
label control does not require a mnemonic for the function to operate.
|
| SetWindowLoc |
Moves a window to a new position (x, y) on the X and Y axes.
|
| SetWindowSize |
Resizes a window.
|
| SetWindowText |
Sets the text of a window.
|
| ShowWindow |
Makes a window visible.
|
| ShowWindowAndLabel |
Makes a window and its associated label visible. A label is the label control that
immediately precedes the window in the outline.
|
| StartTrace |
Begins tracing.
|
| StaticFirst |
Returns a "handle" to the first static on a window
|
| StaticGetLabel |
Gets the static "handle" if the lable for a specified control
|
| StaticGetLoc |
Gets the location coordinates of a static
|
| StaticGetSize |
Gets the size of a static
|
| StaticHide |
Hides a static
|
| StaticIsVisible |
Determines wether a static is visible.
|
| StaticNext |
Returns a "handle" to the last static on a window
|
| StaticSetLoc |
Sets the location coordinates of a static
|
| StaticSetSize |
Sets the size of a static
|
| StaticShow |
Shows a static
|
| StatusGetText |
Gets the text displayed in the status bar of a top-level or MDI window.
|
| StatusSetText |
Displays specified text in the status bar of a top-level or MDI window.
|
| StatusSetVisible |
Shows or hides the status bar on a top-level or MDI window.
|
| StrCompress |
Compresses the specified string.
|
| StrFirstChar |
Extracts the first character of a string and returns its decimal value.
|
| StrGetBufferLength |
Returns the current buffer length of a string.
|
| StrIsValidCurrency |
Verifies that a string represents a valid currency value.
|
| StrIsValidDateTime |
Verifies that string represents a valid date/time value.
|
| StrIsValidDecimal |
Verifies that an entire character string represents a valid decimal value.
|
| StrIsValidIdentifierName |
Returns TRUE if the string is a valid identifier.
|
| StrIsValidNumber |
Verifies that a string represents a valid number value.
|
| StrLeft |
Returns a substring of a specified length starting at position zero.
|
| StrLeftX |
Returns a substring of a specified length starting at position zero.
|
| StrLength |
Returns a string's length.
|
| StrLop |
Returns the UNICODE numeric value of the first character of a string in decimal format
and removes the first character of the string.
|
| StrLower |
Converts a string to lowercase.
|
| StrLowerX |
Converts a string to lowercase.
|
| StrMid |
Returns a substring starting at a specified position and containing a specified number of characters.
|
| StrMidX |
Returns a substring, starting at a specified position and containing a specified number of characters.
|
| StrProper |
Converts a string to a proper name.
|
| StrProperX |
Converts a string to a proper name.
|
| StrRepeat |
Concatenates a string with itself a specified number of times.
|
| StrRepeatX |
Concatenates a string with itself a specified number of times.
|
| StrReplace |
Replaces characters in one string with characters from another string.
|
| StrReplaceX |
Replaces characters in one string with characters from another string.
|
| StrRight |
Returns a string of specified length, starting with the last character in the string.
|
| StrRightX |
Returns a string of specified length, starting with the last character in the string.
|
| StrScan |
Returns the offset of a specified substring.
|
| StrSetBufferLength |
Sets the buffer length of the string to the length plus 1 for the terminator.
|
| StrToDate |
Converts a string to a date/time value.
|
| StrTokenize |
Parses a string into substrings (tokens) based on specified start and end delimiters.
|
| StrToNumber |
Converts a string to a number.
|
| StrTrim |
Strips leading and trailing blanks and compresses multiple spaces and tabs within a string to single spaces.
|
| StrTrimX |
Strips leading and trailing blanks and compresses multiple spaces and tabs within a string to single spaces.
|
| StrUncompress |
Decompresses the specified string.
|
| StrUpper |
Converts a string to uppercase.
|
| StrUpperX |
Converts a string to uppercase.
|
| TBarSetVisible |
Shows or hides the tool bar on a top-level or MDI window.
|
| TblAnyRows |
Determines whether any rows in the specified table window match certain flags.
|
| TblClearSelection |
Deselects all rows of a table window.
|
| TblColumnAverage |
Computes the average of all column values or only specified column values in a table
window.
|
| TblColumnSum |
Computes the sum of all column values or only specified column values in a table
window.
|
| TblCopyRows |
Copies the contents of the specified table window rows to the Clipboard in text format.
|
| TblCreateColumn |
Creates a table window column of string data type at runtime.
|
| TblCreateColumnEx |
Creates a table window column using a given data type at runtime.
Allowed types are DT_String, DT_Number and DT_DateTime
|
| TblDefineCheckBoxColumn |
Define a column as a check box.
|
| TblDefineDropDownListColumn |
Define a column as a drop down list.
|
| TblDefinePopupEditColumn |
Define a column as a popup edit window.
|
| TblDefineRowHeader |
Defines the appearance and behavior of a table window's row header.
|
| TblDefineSplitWindow |
Splits a table window horizontally.
|
| TblDeleteRow |
Deletes a row from a table window but not from the database.
|
| TblDeleteSelected(Control, SalSqlHandle) |
Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
|
| TblDeleteSelected(Control, SalSqlHandle, WhenSqlErrorHandler) |
Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
|
| TblDestroyColumns |
Destroys all automatic columns created by SalTblCreateColumn or SalTblPopulate at
runtime. This function only works on table windows that contain only automatic
columns.
|
| TblDoDeletes(Control, SalSqlHandle, SalNumber) |
Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.
|
| TblDoDeletes(Control, SalSqlHandle, SalNumber, WhenSqlErrorHandler) |
Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.
|
| TblDoInserts(Control, SalSqlHandle, SalBoolean) |
Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
|
| TblDoInserts(Control, SalSqlHandle, SalBoolean, WhenSqlErrorHandler) |
Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
|
| TblDoUpdates(Control, SalSqlHandle, SalBoolean) |
Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
|
| TblDoUpdates(Control, SalSqlHandle, SalBoolean, WhenSqlErrorHandler) |
Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
|
| TblFetchRow |
Sends a SAM_FetchRow message to a table window if the row you specify is not currently
in the table window cache.
|
| TblFindNextRow |
Scans forward in a table looking for a row whose flags match those specified.
|
| TblFindPrevRow |
Scans backward in a table looking for a row whose flags match those specified.
|
| TblGetColumnText |
Gets data from a column of a table window's context row.
|
| TblGetColumnTitle |
Gets the title of a table window column.
|
| TblGetColumnWindow |
Gets the handle of a table window column.
|
| TblInsertRow |
Inserts a new blank row into a table window.
|
| TblKillEdit |
Takes a row out of edit mode and selects the row. This causes the row to receive
both SAM_Validate and SAM_KillFocus messages.
|
| TblKillFocus | |
| TblObjectsFromPoint |
Returns the part of the table window located at a given coordinate.
|
| TblPasteRows |
Pastes the contents of the Clipboard to the specified table window. Assumes
the Clipboard data is in text format with cells delimited by tab characters and
rows delimited by end-of-line characters. Inserts the new rows into the
table window without overwriting existing rows, and converts the data to the
data types of the corresponding table window columns.
|
| TblPopulate(Control, SalSqlHandle, SalString, SalNumber) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| TblPopulate(Control, SalSqlHandle, SalString, SalNumber, WhenSqlErrorHandler) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| TblQueryCheckBoxColumn |
If the column is defined as a check box, this function retrieves information about
the check box and returns TRUE. If it is not a check box, this function returns
FALSE.
|
| TblQueryColumnCellType |
Indicates whether a column is a checkbox, drop down list, popup edit, or standard
column.
|
| TblQueryColumnFlags |
Tests the state of a table window column's flags.
|
| TblQueryColumnID |
Gets a table window column's identifier.
|
| TblQueryColumnPos |
Gets a table window column's relative position.
|
| TblQueryColumnWidth |
Returns the width (in form units) of a table window column.
|
| TblQueryContext |
Returns a table window's current context row. Before sending a SAM_FetchRow message,
automatically sets the context row so that assignments made while processing
the message reference the correct row.
|
| TblQueryDropDownListColumn |
If the column is defined as a drop down list, this function retrieves information
about the list and returns TRUE. If it is not a drop down list, this function returns
FALSE.
|
| TblQueryFocus |
Identifies the cell in a table window with the focus.
|
| TblQueryLinesPerRow |
Retrieves the height of a row in lines.
|
| TblQueryLockedColumns |
Retrieves the number of locked table window columns.
|
| TblQueryPopupEditColumn |
If the column is defined as a popup edit, this function retrieves information about
the popup edit and returns TRUE. If it is not a popup edit, this function returns
FALSE.
|
| TblQueryRowFlags |
Queries a row's flags.
|
| TblQueryRowHeader |
Gets a table window's row header definition.
|
| TblQueryScroll |
Returns a table window's current scroll position and range. The scroll position is
the row number of the row that is currently at the top of the window. You set
the table window range with SalTblSetRange and change it when you insert
or delete rows from the table window.
|
| TblQuerySplitWindow |
Specifies how a table window is split horizontally.
|
| TblQueryTableFlags |
Tests the state of a table window's flags.
|
| TblQueryVisibleRange |
Returns the current range of visible rows in a table window.
|
| TblReset |
Clears a table window by discarding all rows from the table window cache and setting
the table range to 0, -1.
|
| TblScroll(Control, SalNumber, Control) |
Scrolls a table window to the specified row and column.
|
| TblScroll(Control, SalNumber, Control, SalNumber) |
Scrolls a table window to the specified row and column.
|
| TblSetCellTextColor(Control, SalNumber) |
Changes a table window cell's text color.
|
| TblSetCellTextColor(Control, SalNumber, SalBoolean) |
Changes a table window cell's text color.
|
| TblSetColumnFlags |
Sets or clears a table window column's flags.
|
| TblSetColumnPos |
Moves a table window column to a new position.
|
| TblSetColumnText |
Assigns data to a column of a table window's context row.
|
| TblSetColumnTitle |
Sets the title of a table window column.
|
| TblSetColumnWidth |
Sets a table window column's display width.
|
| TblSetContext |
Sets a table window's context row. Setting the context row does not send a SAM_FetchRow
message. If the row is not currently in memory, creates a new row
in memory and sets its cell values to null.
|
| TblSetFlagsAnyRows |
Sets or clears row flags.
|
| TblSetFocusCell |
Sets the focus to the specified table window cell (row and column). Puts
the table window into edit mode and lets the user select a portion of the data in
the cell.
|
| TblSetFocusRow |
Sets a table window's focus frame row.
|
| TblSetLinesPerRow |
Sets the height of a row in lines.
|
| TblSetLockedColumns |
Sets the number of locked table window columns.
|
| TblSetRange |
Defines the minimum and maximum rows (range) of a table.
|
| TblSetRow |
Sets the focus to the first, last, next, or previous row in a table window.
|
| TblSetRowFlags |
Sets or clears a table window row's flags.
|
| TblSetTableFlags |
Sets or clears a table window's flags.
|
| TblSortRows |
Sorts the rows of a table window based on the values in one of the
table window's columns.
|
| TimerKill |
Destroys an object's system timer.
|
| TimerSet |
Creates a system timer for a given object. When a timer event occurs, sends
SAM_Timer messages to the object in specified intervals. Timers are a limited
global resource. Your application must check the value returned by SalTimerSet
to verify that the timer was created.
|
| Trace |
Outputs a string to the trace output target.
|
| TrackPopupMenu(Control, SalString, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| TrackPopupMenu(Control, Type, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| UpdateWindow |
Forces the update of a window.
|
| UseEventLog |
Enables logging of unhandled exceptions in the event log.
|
| UseRegistry |
Redirects all SalProfile* functions to use the Registry.
|
| WaitCursor |
Displays or removes the hourglass cursor.
|
| ValidateSet | Obsolete.
Not supported.
|
| WindowClassName |
Return the name of a window's class as a string.
|
| WindowGetDockSetting |
Retrieves information about the docking capabilities of a top-level window.
|
| WindowGetProperty |
Gets the value of a named property.
|
| WindowHandleToNumber(SalFileHandle) |
Converts a SalFileHandle to a number.
|
| WindowHandleToNumber(SalSqlHandle) |
Converts a SalSqlHandle to a number.
|
| WindowHandleToNumber(SalSqlSessionHandle) |
Converts a SalSqlSessionHandle to a number.
|
| WindowHandleToNumber(SalWindowHandle) |
Converts a SalWindowHandle to a number.
|
| WindowIsDerivedFromClass |
Determines whether a window is an instance of the specified class.
|
| WindowSetProperty |
Sets the value of a named property.
|
| WinHelp |
Starts the Windows help system. Sends a SAM_Help message to the top-level
object when the user presses the F1 key. Process this message by calling SalWinHelp.
|
| Yield |
Processes messages in the message loop.
This function replaces all SalYield* functions.
It must be placed in the loop that block execution.
|
| YieldEnable | Obsolete.
Not Supported.
|
| YieldQueryState | Obsolete.
Not Supported.
|
| YieldStartMessages | Obsolete.
Not Supported.
|
| YieldStopMessages | Obsolete.
Not Supported.
|
Properties
| Name | Description | |
|---|---|---|
 | Interpreter |
Returns the instance of the interpreter used by SalCompileAndEvaluate.
|
| SalReportType |
Returns/Sets the type of the ISalReport implementation.
|
