Sal
PPJ.Runtime.Sal
Namespace: PPJ.Runtime
Assembly: PPJ.Runtime.49 (4.9.0.0)
Contains all Sal.* static functions.
public class SalProperties
Interpreter
InterpreterScriptEngine: Returns the instance of the interpreter used by SalCompileAndEvaluate.
SalReportType
SalReportTypeType: Returns/Sets the type of the ISalReport implementation.
Methods
Abort(exitCode)
Abort(exitCode)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.
ActiveXAutoErrorMode(on)
ActiveXAutoErrorMode(on)Turns on/off automatic COM error handling.
Returns: SalBoolean.
ActiveXDoVerb(ctrl, verb, size)
ActiveXDoVerb(ctrl, verb, size)Perform one of the object's enumerated actions.
Returns: SalBoolean.
ActiveXGetObject(ctrl, obj)
ActiveXGetObject(ctrl, obj)Returns the COM object for the specified AX control.
Returns: SalBoolean.
AppDisable()
AppDisable()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.
AppEnable()
AppEnable()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.
AppFind(name, activate)
AppFind(name, activate)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.
ArrayAvg(array)
ArrayAvg(array)Returns the average value of all the numbers in an array.
Returns: SalNumber. the average value in an array of numbers.
ArrayDimCount(array, dim)
ArrayDimCount(array, dim)Returns: SalBoolean.
ArrayGetLowerBound(array, dim, bound)
ArrayGetLowerBound(array, dim, bound)Returns: SalBoolean.
ArrayGetUpperBound(array, dim, bound)
ArrayGetUpperBound(array, dim, bound)Returns: SalBoolean.
ArrayIsEmpty(array)
ArrayIsEmpty(array)Determines if a dynamic array contains data.
Returns: SalBoolean. true if the array contains no data and false if it is has data.
ArrayMax(array)
ArrayMax(array)Returns the maximum value in an array of numbers.
Returns: SalNumber. the maximum value in an array of numbers.
ArrayMin(array)
ArrayMin(array)Returns the minimum value in an array of numbers.
Returns: SalNumber. the minimum value in an array of numbers.
ArrayQueryBounds(array, min, max)
ArrayQueryBounds(array, min, max)Returns: SalNumber.
ArraySetBounds(array, lower, upper)
ArraySetBounds(array, lower, upper)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
ArraySetUpperBound(array, dim, bound)
ArraySetUpperBound(array, dim, bound)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.
ArraySum(array)
ArraySum(array)Returns the sum of the elements in an array of numbers.
Returns: SalNumber. the sum of the elements in an array of numbers.
BringWindowToTop(ctrl)
BringWindowToTop(ctrl)Brings a window to the top of all overlapping windows.
Returns: SalBoolean. true if the function succeeds and false if it fails.
CenterWindow(ctrl)
CenterWindow(ctrl)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.
ClearField(ctrl)
ClearField(ctrl)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.
ColorFromRGB(red, green, blue)
ColorFromRGB(red, green, blue)Composes a color from red, green, and blue values.
Returns: SalNumber. the color created.
ColorGet(ctrl, colorIndex)
ColorGet(ctrl, colorIndex)Gets a window's color.
colorIndex
The color part of the control, represented by one of these constants: COLOR_IndexCellTextCOLOR_IndexTransparentCOLOR_IndexWindowCOLOR_IndexWindowText
Returns: SalNumber. the color
If you specify COLOR_IndexTransparent in the second parameter and the transparent color is not set, ColorGet() returns COLOR_None.
ColorGetSysColor(colorIndex)
ColorGetSysColor(colorIndex)Gets a system color.
colorIndex
The color of a part of the window, represented by one of these constants: COLOR_SysWindowCOLOR_SysWindowFrameCOLOR_SysWindowText
Returns: SalNumber. the color
ColorSet(ctrl, colorIndex, colorValue)
ColorSet(ctrl, colorIndex, colorValue)Sets a window's color.
colorIndex
The color of a part of the window, represented by one of these constants: COLOR_IndexCellTextCOLOR_IndexTransparentCOLOR_IndexWindowCOLOR_SysWindowText
colorValue
A user-defined value, a value formulated using ColorFromRGB or any of the predefined windows colors. To turn off the transparent color, specify COLOR_None Note: When specifying an explicit RGB color, the COLORREF value has a hexadecimal form of 0x00bbggrr.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ColorToRGB(colorValue, red, green, blue)
ColorToRGB(colorValue, red, green, blue)Returns: SalBoolean.
ColorToRGB(color, red, green, blue)
ColorToRGB(color, red, green, blue)Returns: SalBoolean.
CompileAndEvaluate(expression, error, errorPos, numReturn, sReturn, dtReturn, windowReturn, inhibitErrors, context)
CompileAndEvaluate(expression, error, errorPos, numReturn, sReturn, dtReturn, windowReturn, inhibitErrors, context)Returns: SalNumber.
ContextBreak()
ContextBreak()
Deprecated: Use this. Not supported.
Returns: SalString.
ContextCurrent(context)
ContextCurrent(context)Returns an instance of SalStringContext wrapping the current context reference.
Returns: SalStringContext.
ContextMenuSetPopup(ctrl, menuName, flags)
ContextMenuSetPopup(ctrl, menuName, flags)Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
menuName
A named menu defined in one of the Named Menus section in ctrl, ctrl's MDI window parent, or Global Declarations.
flags
Set this to CM_TableCell to replace the default menu that Windows displays when the mouse pointer is in an editable table window cell. Otherwise, set this to zero.
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.
ContextMenuSetPopup(ctrl, menuType, flags)
ContextMenuSetPopup(ctrl, menuType, flags)Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
flags
Set this to CM_TableCell to replace the default menu that Windows displays when the mouse pointer is in an editable table window cell. Otherwise, set this to zero.
Returns: SalBoolean. true if this function succeeds and false otherwise.
CreateWindow(wndToCreate, parent, parameters)
CreateWindow(wndToCreate, parent, parameters)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.
CreateWindow(formName, parent, parameters)
CreateWindow(formName, parent, parameters)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.
CreateWindow(formName, parent)
CreateWindow(formName, parent)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.
CreateWindowEx(wndToCreate, parent, left, top, width, height, flags, parameters)
CreateWindowEx(wndToCreate, parent, left, top, width, height, flags, parameters)Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.
parent
The name of the parent window. Specify hWndNULL if there is no owner window. Note that if you create a top-level form inside a MDI window, then that MDI window will always own the form.
flags
You can combine these flags with the '|' operator. CREATE_AsChild: Create the window as a child of parent which must be a form, dialog box or tool bar. CREATE_Border: When used with CREATE_AsChild, the window will have a border. CREATE_Hidden: Create the window, but do not show it.
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.
CreateWindowEx(formName, parent, left, top, width, height, flags)
CreateWindowEx(formName, parent, left, top, width, height, flags)Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.
parent
The name of the parent window. Specify hWndNULL if there is no owner window. Note that if you create a top-level form inside a MDI window, then that MDI window will always own the form.
flags
You can combine these flags with the '|' operator. CREATE_AsChild: Create the window as a child of parent which must be a form, dialog box or tool bar. CREATE_Border: When used with CREATE_AsChild, the window will have a border. CREATE_Hidden: Create the window, but do not show it.
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.
CreateWindowExFromStr(formName, parent, left, top, width, height, flags)
CreateWindowExFromStr(formName, parent, left, top, width, height, flags)Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.
parent
The name of the parent window. Specify hWndNULL if there is no owner window. Note that if you create a top-level form inside a MDI window, then that MDI window will always own the form.
flags
You can combine these flags with the '|' operator. CREATE_AsChild: Create the window as a child of parent which must be a form, dialog box or tool bar. CREATE_Border: When used with CREATE_AsChild, the window will have a border. CREATE_Hidden: Create the window, but do not show it.
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.
CreateWindowFromStr(formName, parent)
CreateWindowFromStr(formName, parent)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.
CursorClear(ctrl, type)
CursorClear(ctrl, type)Clears a window's cursor.
Returns: SalBoolean.
CursorSet(ctrl, resource, type)
CursorSet(ctrl, resource, type)Sets a window's cursor.
Returns: SalBoolean.
CursorSet(ctrl, resourceId, type)
CursorSet(ctrl, resourceId, type)Sets a window's cursor.
Returns: SalBoolean.
CursorSetFile(ctrl, fileName, type)
CursorSetFile(ctrl, fileName, type)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.
CursorSetString(ctrl, blob, type)
CursorSetString(ctrl, blob, type)Sets a window's cursor from a string variable.
Returns: SalBoolean.
DateConstruct(year, month, day, hour, minute, second)
DateConstruct(year, month, day, hour, minute, second)Returns the date/time constructed from the parameters year, nMonth, nDay, nHour, minute, and nSecond.
Returns: SalDateTime.
DateCurrent()
DateCurrent()Returns the PC's current date/time.
Returns: SalDateTime.
DateDay(dateTime)
DateDay(dateTime)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.
DateHour(dateTime)
DateHour(dateTime)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.
DateMinute(dateTime)
DateMinute(dateTime)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.
DateMonth(dateTime)
DateMonth(dateTime)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.
DateMonthBegin(dateTime)
DateMonthBegin(dateTime)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.
DateQuarter(dateTime)
DateQuarter(dateTime)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.
DateQuarterBegin(dateTime)
DateQuarterBegin(dateTime)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.
DateSecond(dateTime)
DateSecond(dateTime)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.
DateToStr(date, target)
DateToStr(date, target)Returns: SalNumber.
DateWeekBegin(dateTime)
DateWeekBegin(dateTime)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.
DateWeekday(dateTime)
DateWeekday(dateTime)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.
DateYear(dateTime)
DateYear(dateTime)Returns the year portion of a date or returns -1 if you specify DATETIME_Null as a parameter.
Returns: SalNumber.
DateYearBegin(dateTime)
DateYearBegin(dateTime)Returns the date of the first day of the year or it returns DATETIME_Null if the value you specify is null.
Returns: SalDateTime.
DestroyWindow(ctrl)
DestroyWindow(ctrl)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.
DisableWindow(ctrl)
DisableWindow(ctrl)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.
DisableWindowAndLabel(ctrl)
DisableWindowAndLabel(ctrl)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.
DlgChooseColor(ctrl, colorValue)
DlgChooseColor(ctrl, colorValue)Returns: SalBoolean.
DlgChooseFont(ctrl, name, size, enhancements, color)
DlgChooseFont(ctrl, name, size, enhancements, color)Returns: SalBoolean.
DlgGetDockStatus(windowDlg, orientation)
DlgGetDockStatus(windowDlg, orientation)Returns: SalBoolean.
DlgOpenFile(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileName, filePath)
DlgOpenFile(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileName, filePath)Returns: SalBoolean.
DlgOpenFileMulti(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileNames, filePaths, fileCount)
DlgOpenFileMulti(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileNames, filePaths, fileCount)Returns: SalBoolean.
DlgSaveFile(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileName, filePath)
DlgSaveFile(ctrl, dialogTitle, filters, filtersCount, filterIndex, fileName, filePath)Returns: SalBoolean.
DlgSetDockStatus(windowDlg, orientation)
DlgSetDockStatus(windowDlg, orientation)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.
DragDropDisableDrop()
DragDropDisableDrop()Disables dropping while in drag mode.
Returns: SalBoolean.
DragDropEnableDrop()
DragDropEnableDrop()Enables dropping while in drag mode.
Returns: SalBoolean.
DragDropGetSource(window, x, y)
DragDropGetSource(window, x, y)Returns: SalBoolean.
DragDropGetTarget(windowTarget, x, y)
DragDropGetTarget(windowTarget, x, y)Returns: SalBoolean.
DragDropStart(ctrl)
DragDropStart(ctrl)Initiates drag mode.
Returns: SalBoolean.
DragDropStop()
DragDropStop()Ends drag mode.
Returns: SalBoolean.
DrawMenuBar(ctrl)
DrawMenuBar(ctrl)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.
DropFilesAcceptFiles(ctrl, accept)
DropFilesAcceptFiles(ctrl, accept)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.
DropFilesQueryFiles(ctrl, arrayFiles)
DropFilesQueryFiles(ctrl, arrayFiles)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.
DropFilesQueryPoint(ctrl, x, y)
DropFilesQueryPoint(ctrl, x, y)Returns: SalBoolean.
EditCanCopy()
EditCanCopy()Indicates whether you can copy from the currently selected control on the clipboard.
Returns: SalBoolean. bOk
EditCanCopyTo()
EditCanCopyTo()Deprecated: Not supported. There is no OLE support in .NET. Not Supported.
Returns: SalBoolean.
EditCanCut()
EditCanCut()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.
EditCanPaste()
EditCanPaste()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.
EditCanPasteFrom()
EditCanPasteFrom()Deprecated: Not supported. There is no OLE support in .NET. Not Supported.
Returns: SalBoolean.
EditCanUndo()
EditCanUndo()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.
EditClear()
EditClear()Deletes selected data from the currently selected control
Returns: SalBoolean. true if the function succeeds and false if it fails.
EditCopy()
EditCopy()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.
EditCopyString(str)
EditCopyString(str)Copies a string to the Clipboard as text.
Returns: SalBoolean. true if the function succeeds and false if it fails.
EditCopyTo()
EditCopyTo()Deprecated: Not supported. There is no OLE support in .NET. Not Supported.
Returns: SalBoolean.
EditCut()
EditCut()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.
EditPaste()
EditPaste()Pastes data from the Clipboard into the currently selected control
Returns: SalBoolean. true if the function succeeds and false if it fails.
EditPasteFrom()
EditPasteFrom()Deprecated: Not supported. There is no OLE support in .NET. Not supported
Returns: SalBoolean.
EditPasteString(str)
EditPasteString(str)Returns: SalBoolean.
EditUndo()
EditUndo()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.
EnableWindow(ctrl)
EnableWindow(ctrl)Enables keyboard and mouse input to a window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
EnableWindowAndLabel(ctrl)
EnableWindowAndLabel(ctrl)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.
EndDialog(ctrl, returnValue)
EndDialog(ctrl, returnValue)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.
EndTrace()
EndTrace()Stops tracing.
Returns: SalBoolean.
FileClose(file)
FileClose(file)Returns: SalBoolean.
FileCopy(sourcePath, destPath, overwrite)
FileCopy(sourcePath, destPath, overwrite)Copies the contents of one file (source) to another file (destination).
overwrite
Specifies whether (TRUE) or not (FALSE) to overwrite the destination file. If the destination file already exists and overwrite is FALSE, then FileCopy fails, and returns FILE_CopyExist. If the destination file already exists and overwrite is TRUE, then FileCopy succeeds and the destination file is overwritten.
Returns: SalNumber. One of the following values: FILE_CopyDest, FILE_CopyExist, FILE_CopyOK, FILE_CopyRead, FILE_CopySrc, FILE_CopyWrite.
FileCreateDirectory(directory)
FileCreateDirectory(directory)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.
FileGetChar(file, charValue)
FileGetChar(file, charValue)Returns: SalBoolean.
FileGetChar(file)
FileGetChar(file)Returns the next character in an open file.
Returns: SalNumber. the next character in an open file.
FileGetCurrentDirectory(path)
FileGetCurrentDirectory(path)Returns: SalBoolean.
FileGetDateTime(fileName, dateTime)
FileGetDateTime(fileName, dateTime)Returns: SalBoolean.
FileGetDrive()
FileGetDrive()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(:).
FileGetStr(file, buffer, bufferSize)
FileGetStr(file, buffer, bufferSize)Returns: SalBoolean.
FileOpen(file, fileName, style)
FileOpen(file, fileName, style)Returns: SalBoolean.
FileOpen(file, fileName, style, encoding)
FileOpen(file, fileName, style, encoding)Returns: SalBoolean.
FileOpenExt(file, fileName, style, reopen)
FileOpenExt(file, fileName, style, reopen)Deprecated: Use Sal.FileOpen().
Returns: SalBoolean.
FilePutChar(file, charValue)
FilePutChar(file, charValue)Writes a character to an open file.
Returns: SalBoolean. true if the function succeeds and false if it fails.
FilePutStr(file, str)
FilePutStr(file, str)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.
FileRead(file, buffer, bufferLength)
FileRead(file, buffer, bufferLength)Returns: SalNumber.
FileRead(file, buffer, bufferLength)
FileRead(file, buffer, bufferLength)Returns: SalNumber.
FileRemoveDirectory(directory)
FileRemoveDirectory(directory)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.
FileSeek(file, bytes, position)
FileSeek(file, bytes, position)Positions the file pointer in an open file. The next file operation (such as a read or write) takes place at this new location.
bytes
The specific position of the file pointer; the number of bytes from position where the next file operation will take place.
position
The general position of the file pointer; one of the following values: FILE_SeekBegin, FILE_SeekCurrent, FILE_SeekEnd.
Returns: SalBoolean. true if the function succeeds and false if it fails.
FileSetCurrentDirectory(path)
FileSetCurrentDirectory(path)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.
FileSetDateTime(fileName, dateTime)
FileSetDateTime(fileName, dateTime)Sets the modification date and time of the specified file.
Returns: SalBoolean. true if the function succeeds and false if it fails.
FileSetDrive(sDriveLetter)
FileSetDrive(sDriveLetter)Sets the current disk drive to the specified drive letter.
sDriveLetter
The new disk drive letter. The length of this parameter's value is one character. If you specify a value larger than this, reads only the first character.
Returns: SalBoolean. true if the function succeeds and false if it fails.
FileTell(file)
FileTell(file)Returns the current position in an open file.
Returns: SalNumber. the current position (in bytes) in file. If an error occurs, returns -1.
FileWrite(file, buffer, bufferLength)
FileWrite(file, buffer, bufferLength)Writes a string to an open file.
Returns: SalNumber. the number of bytes written.
FileWrite(file, buffer, bufferLength)
FileWrite(file, buffer, bufferLength)Writes a binary buffer to an open file.
Returns: SalNumber. the number of bytes written.
FindWindow(ctrl, windowName)
FindWindow(ctrl, windowName)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.
FireWindowActions(ctrl, message, wParam, lParam)
FireWindowActions(ctrl, message, wParam, lParam)Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Returns: SalNumber.
FireWindowActionsToChildren(ctrl, message, wParam, lParam)
FireWindowActionsToChildren(ctrl, message, wParam, lParam)Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.
Returns: SalBoolean.
FmtCopyProfile(ctrl, nProfile)
FmtCopyProfile(ctrl, nProfile)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.
FmtFieldToStr(ctrl, text, format)
FmtFieldToStr(ctrl, text, format)Returns: SalBoolean.
FmtFormatDateTime(dateTime, sPicture)
FmtFormatDateTime(dateTime, sPicture)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.
FmtFormatNumber(num, sPicture)
FmtFormatNumber(num, sPicture)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.
FmtGetFormat(ctrl)
FmtGetFormat(ctrl)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.
FmtGetInputMask(ctrl, mask)
FmtGetInputMask(ctrl, mask)Returns: SalBoolean.
FmtGetParmNum(ctrl, nParm, nValue)
FmtGetParmNum(ctrl, nParm, nValue)Returns: SalBoolean.
FmtGetParmStr(ctrl, nParm, value)
FmtGetParmStr(ctrl, nParm, value)Returns: SalBoolean.
FmtGetPicture(ctrl, format)
FmtGetPicture(ctrl, format)Returns: SalBoolean.
FmtGetProfile(ctrl)
FmtGetProfile(ctrl)Returns the culture profile for the specified field.
Returns: SalNumber.
FmtIsValidField(ctrl)
FmtIsValidField(ctrl)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.
FmtIsValidInputMask(mask)
FmtIsValidInputMask(mask)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.
FmtIsValidPicture(format, type)
FmtIsValidPicture(format, type)Validates a numeric or date/time picture format.
type
Specify whether the format is for a number or date/time value with one of these constants: FMT_Pic_DateTimeFMT_Pic_Number
Returns: SalBoolean. true if the picture format is valid and false otherwise.
These are examples of date/time picture formats: |
d MMMM, yyyy
dddd, MMMM d, yyyy
M/d/yy
dd-MM-yyyy
d "of " MMMM, yyyy
M/d/yy-hh.mm.ss AMPM
These are examples of number picture formats:
Number Picture
:---
0.00%
0.00e+00
0.00e-00
$#,##0; ($#,##0)
$#,##0; ($#,##0)
0.00
FmtKeepMask(keep)
FmtKeepMask(keep)Turns on/off the flag that indicates whether to keep the mask when reading the text from masked edit controls.
keep
If false (default), removes input mask characters when you copy a value. If true, keeps the input mask characters when you copy a value.
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.
FmtSetFormat(ctrl, format)
FmtSetFormat(ctrl, format)Sets a data field's or table window column's format.
format
The format for ctrl. Potential formats include: FMT_Format_Currency, FMT_Format_Date, FMT_Format_DateTime, FMT_Format_Decimal, FMT_Format_Invisible, FMT_Format_LowerCase, FMT_Format_Percentage, FMT_Format_PictureFMT_Format_Time, FMT_Format_Unformatted, and FMT_Format_UpperCase.
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.
FmtSetInputMask(ctrl, mask)
FmtSetInputMask(ctrl, mask)Sets the input mask of a data field or table window column.
Returns: SalBoolean. true if the function succeeds and false if it fails.
FmtSetParmNum(ctrl, nParm, nValue)
FmtSetParmNum(ctrl, nParm, nValue)Modifies the specified formatting rule on the control. The control must use the customized profile set using FMT_Profile_Program.
Returns: SalBoolean.
FmtSetParmStr(ctrl, nParm, value)
FmtSetParmStr(ctrl, nParm, value)Modifies the specified formatting rule on the control. The control must use the customized profile set using FMT_Profile_Program.
Returns: SalBoolean.
FmtSetPicture(ctrl, picture)
FmtSetPicture(ctrl, picture)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.
FmtSetProfile(ctrl, nProfile)
FmtSetProfile(ctrl, nProfile)Changes the culture profile for the specified field.
Returns: SalBoolean.
FmtStrToField(ctrl, value, format)
FmtStrToField(ctrl, value, format)Copies a string to a data field or table window column. After copying the string to the field, formats the string.
format
Specify whether (true) or not (false) the string value has the same format as the field.
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.
FmtUnmaskInput(ctrl, text)
FmtUnmaskInput(ctrl, text)Returns: SalBoolean.
FmtValidateField(ctrl, validate)
FmtValidateField(ctrl, validate)Validates and formats a data field's or table window column's contents.
validate
A constant value that indicates what happens if a format error occurs and the function returns FALSE: FMT_Validate_DialogFMT_Validate_None
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.
FontGet(ctrl, name, size, enhancement)
FontGet(ctrl, name, size, enhancement)Returns: SalBoolean.
FontGetNames(type, fonts)
FontGetNames(type, fonts)Gets the names of the fonts.
fonts
Receives the name of an array of strings that contains the font names returned.
Returns: SalNumber. the number of font names returned.
FontGetSizes(get, fontName, fontSizes)
FontGetSizes(get, fontName, fontSizes)Deprecated: Use FontFamilies instead.
Returns: SalNumber.
FontSet(ctrl, name, size, enhancement)
FontSet(ctrl, name, size, enhancement)Sets a window's font, font size, and font enhancements.
enhancement
The font enhancements ie bold, italic in the form of font enhancement flags. To combine two or more of the font enhancement flags, use the OR (|) operator.
Returns: SalBoolean. true if the function succeeds and false if it fails.
Font Enhancement Flags: FONT_EnhBoldFONT_EnhDefaultFONT_EnhItalicFONT_EnhNormalFONT_EnhStrikeOutFONT_EnhUnderline
FormGetParmNum(ctrl, paramType, value)
FormGetParmNum(ctrl, paramType, value)Returns: SalBoolean.
FormUnitsToPixels(ctrl, formUnits, vertical)
FormUnitsToPixels(ctrl, formUnits, vertical)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.
vertical
If the form units are on the X axis, set this parameter to false. If the form units are on the Y axis, set this parameter to true.
Returns: SalNumber. the number of pixels if the function succeeds. Returns zero (0) if ctrl is invalid.
GetBufferLength(buffer)
GetBufferLength(buffer)Returns the current buffer length of a binary variable.
Returns: SalNumber. The number of bytes used.
GetBufferLength(str)
GetBufferLength(str)Returns the current buffer length of a string.
Returns: SalNumber. The number of bytes used.
GetDataType(ctrl)
GetDataType(ctrl)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_DateTimeDT_LongStringDT_NumberDT_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.
GetDefButton(ctrl)
GetDefButton(ctrl)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.
GetFirstChild(ctrl, typeMask)
GetFirstChild(ctrl, typeMask)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_AccFrameTYPE_AnyTYPE_BkgdTextTYPE_CheckBoxTYPE_ChildGridTYPE_ChildTableTYPE_ComboBoxTYPE_CustControlTYPE_DataFieldTYPE_DatePickerTYPE_DateTimePickerTYPE_DialogBoxTYPE_FormToolBarTYPE_FormWindowTYPE_FrameTYPE_GridWindowTYPE_GroupBoxTYPE_HorizScrollBarTYPE_LineTYPE_ListBoxTYPE_MDIWindowTYPE_MultilineTextTYPE_OptButtonTYPE_PictureTYPE_PushButtonTYPE_RadioButtonTYPE_TabBarTYPE_TableColumnTYPE_TableWindowTYPE_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.
GetFocus()
GetFocus()Returns the handle of the window with the focus.
Returns: SalWindowHandle. windowFocus which identifies the window that can currently receive input from the keyboard.
GetItemName(ctrl, name)
GetItemName(ctrl, name)Returns: SalBoolean.
GetMaxDataLength(ctrl)
GetMaxDataLength(ctrl)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.
GetNextChild(ctrl, typeMask)
GetNextChild(ctrl, typeMask)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_AccFrameTYPE_AnyTYPE_BkgdTextTYPE_CheckBoxTYPE_ChildGridTYPE_ChildTableTYPE_ComboBoxTYPE_CustControlTYPE_DataFieldTYPE_DatePickerTYPE_DateTimePickerTYPE_DialogBoxTYPE_FormToolBarTYPE_FormWindowTYPE_FrameTYPE_GridWindowTYPE_GroupBoxTYPE_HorizScrollBarTYPE_LineTYPE_ListBoxTYPE_MDIWindowTYPE_MultilineTextTYPE_OptButtonTYPE_PictureTYPE_PushButtonTYPE_RadioButtonTYPE_TabBarTYPE_TableColumnTYPE_TableWindowTYPE_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.
GetProfileInt(section, entry, defaultValue, fileName)
GetProfileInt(section, entry, defaultValue, fileName)Retrieves the integer value of an entry in the specified section of an initialization file or registry.
fileName
The name of the initialization file or company name depending on the settings made using the UseRegistry function.
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.
GetProfileString(section, entry, defaultValue, value, fileName)
GetProfileString(section, entry, defaultValue, value, fileName)Returns: SalNumber.
GetReportObject(handle)
GetReportObject(handle)Returns the instance of ISalReport that is identified by the handle.
Returns: ISalReport.
GetVersion()
GetVersion()Returns the version of the library.
Returns: SalNumber. The version number.
GetWindowLabel(ctrl)
GetWindowLabel(ctrl)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.
GetWindowLabelText(ctrl, text, maxLength)
GetWindowLabelText(ctrl, text, maxLength)Returns: SalNumber.
GetWindowLoc(ctrl, x, y)
GetWindowLoc(ctrl, x, y)Returns: SalBoolean.
GetWindowSize(ctrl, width, height)
GetWindowSize(ctrl, width, height)Returns: SalBoolean.
GetWindowState(ctrl)
GetWindowState(ctrl)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_InvalidWindow_MaximizedWindow_MinimizedWindow_NormalWindow_NotVisible).
GetWindowText(ctrl, text, maxLen)
GetWindowText(ctrl, text, maxLen)Returns: SalNumber.
HideWindow(ctrl)
HideWindow(ctrl)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.
HideWindowAndLabel(ctrl)
HideWindowAndLabel(ctrl)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.
HStringToNumber(str)
HStringToNumber(str)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.
IdleKick()
IdleKick()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.
IdleRegisterWindow(ctrl, message, wParam, lParam)
IdleRegisterWindow(ctrl, message, wParam, lParam)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.
IdleUnregisterWindow(ctrl)
IdleUnregisterWindow(ctrl)Stops sending idle messages to a control for which you had previously called IdleRegisterWindow
Returns: SalBoolean. true if this function succeeds and false otherwise.
InvalidateWindow(ctrl)
InvalidateWindow(ctrl)Causes a window to be repainted.
Returns: SalBoolean. true if this function succeeds and false otherwise.
IsButtonChecked(ctrl)
IsButtonChecked(ctrl)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.
IsNull(ctrl)
IsNull(ctrl)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.
IsValidDateTime(ctrl)
IsValidDateTime(ctrl)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.
IsValidDecimal(ctrl, precision, scale)
IsValidDecimal(ctrl, precision, scale)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.
IsValidInteger(ctrl)
IsValidInteger(ctrl)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.
IsValidNumber(ctrl)
IsValidNumber(ctrl)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
IsWindowEnabled(ctrl)
IsWindowEnabled(ctrl)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.
IsWindowVisible(ctrl)
IsWindowVisible(ctrl)Determines whether a window is currently visible.
Returns: SalBoolean. true if the window is visible and false otherwise.
ListAdd(ctrl, text)
ListAdd(ctrl, text)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.
ListClear(ctrl)
ListClear(ctrl)Deletes all entries from a list box or combo box.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ListDelete(ctrl, index)
ListDelete(ctrl, index)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.
ListFiles(ctrl, ctrlPath, pathName, attributes)
ListFiles(ctrl, ctrlPath, pathName, attributes)Returns: SalBoolean.
ListGetMultiSelect(ctrl, selectedArray)
ListGetMultiSelect(ctrl, selectedArray)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.
ListInsert(ctrl, index, text)
ListInsert(ctrl, index, text)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.
ListPopulate(ctrl, sql, select)
ListPopulate(ctrl, sql, select)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.
ListPopulate(ctrl, sql, select, errorHandler)
ListPopulate(ctrl, sql, select, errorHandler)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.
ListQueryCount(ctrl)
ListQueryCount(ctrl)Returns the number of list box or combo box entries.
Returns: SalNumber. Number of items in the list.
ListQueryFile(ctrl, fileName)
ListQueryFile(ctrl, fileName)Returns: SalBoolean.
ListQueryMultiCount(ctrl)
ListQueryMultiCount(ctrl)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.
ListQuerySelection(ctrl)
ListQuerySelection(ctrl)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.
ListQueryState(ctrl, index)
ListQueryState(ctrl, index)Determines whether the specified list box or combo box entry is selected.
Returns: SalBoolean. True is the specified item is selected.
ListQueryText(ctrl, index, text)
ListQueryText(ctrl, index, text)Returns: SalNumber.
ListQueryTextLength(ctrl, index)
ListQueryTextLength(ctrl, index)Returns the length of a list box or combo box entry.
Returns: SalNumber. Length of the text of the specified item.
ListQueryTextX(ctrl, index)
ListQueryTextX(ctrl, index)Returns the text of the specified item.
Returns: SalString. Text of the specified item.
ListRedraw(ctrl, redraw)
ListRedraw(ctrl, redraw)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.
ListSelectString(ctrl, startIndex, text)
ListSelectString(ctrl, startIndex, text)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.
ListSetMultiSelect(ctrl, index, select)
ListSetMultiSelect(ctrl, index, select)Selects or deselects a combo box or multiple-selection list box entry.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ListSetSelect(ctrl, index)
ListSetSelect(ctrl, index)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.
ListSetTabs(ctrl, tabStops)
ListSetTabs(ctrl, tabStops)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.
LoadApp(name, parameters)
LoadApp(name, parameters)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.
LoadAppAndProcessMsgs(name, mode, retCode)
LoadAppAndProcessMsgs(name, mode, retCode)Returns: SalBoolean.
LoadAppAndWait(name, mode, retCode)
LoadAppAndWait(name, mode, retCode)Returns: SalBoolean.
Log(fileName, message)
Log(fileName, message)Appends the string to the file.
Returns: SalBoolean.
LogLine(fileName, message)
LogLine(fileName, message)Appends the string and a new line to the file.
Returns: SalBoolean.
LogResource(fileName)
LogResource(fileName)Deprecated: Use Sal.Log(). Logs the available resources to the file.
Returns: SalBoolean.
MapEnterToTab(state)
MapEnterToTab(state)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.
state
If true, the Enter key shifts the focus to the next editable object. If false(default), the Enter key executes the default push button on the form window or dialog box.
Returns: SalBoolean. true if the function succeeds and false if you do not specify a Boolean value.
MDIArrangeIcons(ctrl)
MDIArrangeIcons(ctrl)Arranges minimized child window icons in an MDI window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
MDICascade(ctrl)
MDICascade(ctrl)Cascades all non-iconized child windows of an MDI window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
MDITile(ctrl, position)
MDITile(ctrl, position)Tiles all non-iconized child windows of an MDI window. Windows that are not sizable will not be tiled.
position
How to tile the child windows. If true, tile the windows vertically; if false, tile the windows horizontally
Returns: SalBoolean. true if the function succeeds and false if it fails.
MessageBeep(alertLevel)
MessageBeep(alertLevel)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.
alertLevel
The alert level: Use 0 or -1 for the standard beep using the computer speaker, or any of the MB_* constants.
Returns: SalBoolean. true if the function succeeds and false if it fails.
MB constants: MB_IconAsteriskMB_IconExclamationMB_IconStopMB_IconQuestionMB_Ok
MessageBox(text)
MessageBox(text)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: IDABORTIDCANCELIDIGNOREIDNOIDOKIDRETRYIDYES
MessageBox(text, title, flags)
MessageBox(text, title, flags)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: IDABORTIDCANCELIDIGNOREIDNOIDOKIDRETRYIDYES
A style has four components: Push buttons: MB_AbortRetryIgnoreMB_Ok (default) MB_OkCancelMB_RetryCancelMB_YesNoMB_YesNoCancel Message icons, if any: MB_IconAsteriskMB_IconExclamationMB_IconHandMB_IconQuestionMB_IconStop A default button: MB_DefButton1MB_DefButton2MB_DefButton3MB_NoFocus Whether the message box is system modal: MB_ApplModal (default) or MB_SystemModal
MessageBox(owner, text, title, flags)
MessageBox(owner, text, title, flags)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.
ModalDialog(dialogType, owner, parameters)
ModalDialog(dialogType, owner, parameters)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.
ModalDialog(dialogName, owner, parameters)
ModalDialog(dialogName, owner, parameters)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.
ModalDialog(dialogName, owner)
ModalDialog(dialogName, owner)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.
ModalDialogFromStr(dialogName, owner)
ModalDialogFromStr(dialogName, owner)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.
MoveWindow(ctrl, xOffset, yOffset)
MoveWindow(ctrl, xOffset, yOffset)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.
MTSCreateInstance(obj)
MTSCreateInstance(obj)Returns: SalBoolean.
MTSDisableCommit()
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).
Returns: SalBoolean. true if successful, returns false if it fails.
MTSEnableCommit()
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).
Returns: SalBoolean. true if successful, returns false if it fails.
MTSGetObjectContext(obj, context)
MTSGetObjectContext(obj, context)Deprecated: Not supported.
Returns: SalBoolean.
MTSIsCallerInRole(role, inRole)
MTSIsCallerInRole(role, inRole)Returns: SalBoolean.
MTSIsInTransaction(isInTransaction)
MTSIsInTransaction(isInTransaction)Returns: SalBoolean.
MTSIsSecurityEnabled(isSecurityEnabled)
MTSIsSecurityEnabled(isSecurityEnabled)Returns: SalBoolean.
MTSSetAbort()
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).
Returns: SalBoolean. true if successful, returns false if it fails.
MTSSetComplete()
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).
Returns: SalBoolean. true if successful, returns false if it fails.
NavAddGroup(control, paneIndex, groupIndex, groupTitle, height)
NavAddGroup(control, paneIndex, groupIndex, groupTitle, height)Adds a new group to the specified pane of a navigation bar.
Returns: SalBoolean. true if the function succeeds, false if an error occurs.
See PixelsToFormUnits or FormUnitsToPixels for information about the "form unit". If the group is added before an existing group, the group that follows the new group will resize smaller to accommodate the new group. If the new group is appended, the group that immediately precedes the new group will resize smaller. If this does not provide enough space, the next group will be resized as well. For example, if the newly added group (group A) has a height of 200, and the group preceding it (group B) has a height of 100, group B will shrink to a height of 0, and the group that immediately precedes group B (group C) will have its height reduced by 100. Note: When controls appear above the first defined group separator in a navigation pane, they are categorized as "ungrouped" controls. The controls that appear after the first separator belong to group zero. The controls that appear after the second separator belong to group one. If groupIndex = 0, the new group will appear immediately above the current group zero, and below any "ungrouped" controls.
NavAddPane(control, paneIndex, name, expandedImage, collapsedImage)
NavAddPane(control, paneIndex, name, expandedImage, collapsedImage)Inserts a pane into the navigation bar control.
paneIndex
Indicates a zero-based pane index. The new pane will be inserted after the pane indicated by nPaneIndex. Use -1 to append as the last pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid window handle).
NavAssociateChild(control, paneIndex, groupIndex, child)
NavAssociateChild(control, paneIndex, groupIndex, child)Associates a control to a pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid control).
NavDisassociateChild(control, paneIndex, child)
NavDisassociateChild(control, paneIndex, child)Disassociates a control from a pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid control).
NavEnablePane(control, paneIndex, enable)
NavEnablePane(control, paneIndex, enable)Enables or disables a pane on the navigation bar.
Returns: SalBoolean. the previous state of the pane: true if it was previously enabled, false if it was previously disabled.
NavExpandGroup(control, paneIndex, groupIndex, expand)
NavExpandGroup(control, paneIndex, groupIndex, expand)Expands or collapses a group.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid control).
NavGetActivePane(control)
NavGetActivePane(control)Returns the index of the currently selected pane.
Returns: SalNumber. The zero-based index of the currently selected pane.
NavGetPaneIcon(control, paneIndex, binary, format, expanded)
NavGetPaneIcon(control, paneIndex, binary, format, expanded)Returns: SalBoolean.
NavGetPaneIndex(control, name)
NavGetPaneIndex(control, name)Finds the pane by its name and returns a zero-based index of the pane if successful or -1 if the pane is not found.
Returns: SalNumber. the zero-based index of the pane. If the pane is not found, index is -1.
NavGetPaneTitle(control, paneIndex, title)
NavGetPaneTitle(control, paneIndex, title)Returns: SalBoolean.
NavGetPaneTitle(control, paneIndex)
NavGetPaneTitle(control, paneIndex)Returns the title of a pane.
Returns: SalString. true if the function succeeds, false if it fails (for example, as a result of an invalid control or index).
NavGroupIsExpanded(control, paneIndex, groupIndex)
NavGroupIsExpanded(control, paneIndex, groupIndex)Retrieves the group status. The function returns true if the group is expanded; false if collapsed.
Returns: SalBoolean. true if the group is expanded; false if collapsed.
If the pane is not currently selected, the function returns the cached state which will apply to the group when the pane is selected.
NavLoadState(control, xml)
NavLoadState(control, xml)Restore the settings of a navigation bar from an XML string.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid window control).
Information restored includes: -Navigation bar expanded or collapsed. -Number of buttons visible in the navigation bar. -Enabled panes and disabled panes. -Sequence of the panes. -Current(selected) pane. -States of the groups(expanded or collapsed) in the current pane.
NavPaneIsEnabled(control, paneIndex)
NavPaneIsEnabled(control, paneIndex)Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
Returns: SalBoolean. true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
NavRemoveGroup(control, paneIndex, groupIndex)
NavRemoveGroup(control, paneIndex, groupIndex)Removes a group from the navigation bar control.
Returns: SalBoolean. true if the function succeeds, false if it fails.
NavRemovePane(control, paneIndex)
NavRemovePane(control, paneIndex)Removes a pane from the navigation bar control.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid window handle).
NavSaveState(control, xml)
NavSaveState(control, xml)Returns: SalBoolean.
NavSetActivePane(control, paneIndex)
NavSetActivePane(control, paneIndex)Activates the indicated pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid NavBar control.).
NavSetPaneIcon(control, paneIndex, binary, format, expanded)
NavSetPaneIcon(control, paneIndex, binary, format, expanded)Sets the title of a pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid control or index).
NavSetPaneTitle(control, paneIndex, title)
NavSetPaneTitle(control, paneIndex, title)Sets the title of a pane.
Returns: SalBoolean. true if the function succeeds, false if it fails (for example, as a result of an invalid control or index).
NumberAbs(num)
NumberAbs(num)Computes a number's absolute value.
Returns: SalNumber. the absolute value of num
NumberArcCos(num)
NumberArcCos(num)Computes the arc cosine of a value in the range 0 to 1. The value's domain is -1 to 1.
Returns: SalNumber. the arc cosine of num . Returns NUMBER_Null if num is less than -1 or greater than 1.
NumberArcSin(num)
NumberArcSin(num)Computes a value's arc sine. The value's domain is -1 to 1.
Returns: SalNumber. the arc sine of num . Returns NUMBER_Null if num is less than -1 or greater than 1.
NumberArcTan(num)
NumberArcTan(num)Computes a value's arc tangent.
Returns: SalNumber. the arc tangent of num .The value returned will be in the range -1 to 1.
NumberArcTan2(numY, numX)
NumberArcTan2(numY, numX)Computes the arc tangent of two nums. This function uses the signs of both parameters to determine the quadrant of the return value.
Returns: SalNumber. the arc tangent of numX and numY . The value returned will be in the range -1/2 to 1/2.
NumberCos(angle)
NumberCos(angle)Computes an angle's cosine. You must specify the angle in terms of radians.
Returns: SalNumber. the cosine of nAngle. If the angle is large, the value returned can reflect a partial loss of significance. If the angle is so large that significance is totally lost, returns zero (0).
NumberCosH(angle)
NumberCosH(angle)Computes an angle's hyperbolic cosine. You must specify the angle in terms of radians.
Returns: SalNumber. the hyperbolic cosine of nAngle. If the return value is too large, returns zero (0).
NumberExponent(num)
NumberExponent(num)Computes a value's exponential function.
Returns: SalNumber. the result of 'e' to the power of num . When there is an underflow or overflow, returns NUMBER_Null.
NumberHigh(num)
NumberHigh(num)Returns a number's high-order word value (most significant 16 bits).
Returns: SalNumber. the high-order word value of num
NumberHypot(x, y)
NumberHypot(x, y)Computes the length of the hypotenuse of a right triangle, given the lengths of the other two sides.
Returns: SalNumber. the length of the hypotenuse of a right triangle. If the computation of the hypotenuse results in an overflow, returns zero (0).
NumberLog(num)
NumberLog(num)Computes a number's natural logarithm.
Returns: SalNumber. the natural logarithm of num . If num is negative or 0, returns NUMBER_Null.
NumberLogBase10(num)
NumberLogBase10(num)Computes a number's base -10 logarithm.
Returns: SalNumber. the base-10 logarithm of num . If num is negative or 0, returns NUMBER_Null.
NumberLow(num)
NumberLow(num)Returns a number's low-order word value (least significant 16 bits).
Returns: SalNumber. the low-order word value of num .
NumberMax(num1, num2)
NumberMax(num1, num2)Returns the greater of two numbers.
Returns: SalNumber. the greater of num1 and num2 .
NumberMin(num1, num2)
NumberMin(num1, num2)Returns the lesser of two numbers.
Returns: SalNumber. the lesser of num1 and num2 .
NumberMod(num, mod)
NumberMod(num, mod)Returns a number's modulo. This function divides num by mod and returns the remainder.
Returns: SalNumber. the remainder of num divided by mod .
NumberPi(num)
NumberPi(num)Multiples a number by Pi. Pi is equal to 3.1415926535979323.
Returns: SalNumber. num multiplied by Pi.
NumberPower(num, exponent)
NumberPower(num, exponent)Computes num raised to the power of exponent . This function does not recognize integral, floating-point values greater than 2 to the 64th power, such as 1.0E100.
Returns: SalNumber. num raised to the exponent power, with the following conditions:
If num is not 0 and exponent is 0, returns 1.
If num is 0 and exponent is negative, returns to zero(0).
If both num and exponent are zero(0), or if num is negative and exponent is not a whole number, returns zero(0), meaning that an error occurred.
In instances where an overflow or an underflow occurs, returns zero(0).
NumberRandInit(seed)
NumberRandInit(seed)Sets the starting point for generating a series of pseudo-random numbers using NumberRandom.
Returns: SalBoolean. true if the function succeeds and false if it fails.
Use NumberRandInit() when you want to generate the same set of pseudo-random numbers over and over again (e.g. when doing reproducible experiments).
NumberRandom()
NumberRandom()Generates a pseudo-random number. The numbers generated by this function are integers in the range 0 to 32767.
Returns: SalNumber. a pseudo-random number.
See NumberRandInit
NumberRound(num)
NumberRound(num)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.
Returns: SalNumber. num after rounding.
NumberSin(angle)
NumberSin(angle)Computes an angle's sine. You must specify the angle in terms of radians.
Returns: SalNumber. the sine of angle . If the angle is large, the value returned can reflect a partial loss of significance. If the angle is so large that significance is totally lost, returns zero (0).
NumberSinH(angle)
NumberSinH(angle)Computes an angle's hyperbolic sine. You must specify the angle in terms of radians.
Returns: SalNumber. the hyperbolic sine of nAngle. If the angle is too large, returns zero (0).
NumberSqrt(num)
NumberSqrt(num)Computes a number's square root.
Returns: SalNumber. the square root of num . If num is negative, it is out of the domain of valid values and zero (0) is returned.
NumberTan(angle)
NumberTan(angle)Computes an angle's tangent.
Returns: SalNumber. the tangent of angle . If the angle is large, the value returned can reflect a partial loss of significance. If the angle is so large that significance is totally lost, returns zero (0).
NumberTanH(angle)
NumberTanH(angle)Computes an angle's hyperbolic tangent. You must specify the angle in terms of radians.
Returns: SalNumber. the hyperbolic tangent of angle . If the angle is large, the value returned can reflect a partial loss of significance. If the angle is so large that significance is totally lost, returns zero (0).
NumberToChar(num)
NumberToChar(num)Converts a decimal value to a UNICODE character. This function uses the MultiByteToWideChar API using ANSI code page for numbers less than 255.
Returns: SalString. the character converted from num
NumberToHString(handle)
NumberToHString(handle)Converts a string handle to the corresponding string instance.
Returns: SalString. a string handle that represents the number converted.
NumberToStr(num, decimalPlaces, str)
NumberToStr(num, decimalPlaces, str)Returns: SalNumber.
NumberToStrX(num, decimalPlaces)
NumberToStrX(num, decimalPlaces)Converts a number to a string.
Returns: SalString. the string converted from num
NumberToWindowHandle(num)
NumberToWindowHandle(num)Converts a number to a window handle.
Returns: SalWindowHandle. the window handle converted from num
NumberTruncate(num, precision, scale)
NumberTruncate(num, precision, scale)Truncates a number.
scale
The number of digits to the right of the decimal point. The precision parameter must be large enough to hold the number of digits that you specify in this parameter.
Returns: SalNumber. the result of truncating num
ObjCreateFromString(className)
ObjCreateFromString(className)Creates an instance of the class.
Returns: SalFunctionalClass. Reference to the object created.
ObjGetType(userObject)
ObjGetType(userObject)This function returns the name of the class for the object.
Returns: SalString. Class name of the object if successful, STRING_Null if unsuccessful.
ObjIsDerived(userObject, className)
ObjIsDerived(userObject, className)Returns true if the object is derived from the class specified or an instance of a subclass inherited from the user-defined class.
Returns: SalBoolean. true if userObject is an instance of the class identified by the value of className or if userObject is an instance of a subclass of the class identified by the value of className ; false otherwise.
ObjIsNull(userObject)
ObjIsNull(userObject)This function checks to see if the variable of a functional, CoClass, or interface class is null.
Returns: SalBoolean. true if the parameter is a null reference, and false if it is not.
ObjIsValidClasname(className)
ObjIsValidClasname(className)Determine whether className holds a valid user-defined class name.
Returns: SalBoolean. true if className is valid; false otherwise.
ParentWindow(ctrl)
ParentWindow(ctrl)Returns the handle of an object's parent window.
Returns: SalWindowHandle. parent window handle of ctrl. If ctrl is a top-level window, returns the window handle of the owner window, as passed to CreateWindow, otherwise returns hWndNULL.
|
Tool bar child in a top-level object
Tool bar child in an MDI window
Child table window in a tool bar
Top-level Object in an MDI window
Pause(milliseconds)
Pause(milliseconds)Pauses the application for the specified number of milliseconds. It keeps dispatching messages.
Returns: SalBoolean. true if the function succeeds and false if it fails.
PicClear(ctrl)
PicClear(ctrl)Deletes the contents of a picture.
Returns: SalBoolean. true if the function succeeds and false if hWnd is not a valid picture.
PicGetDescription(ctrl, description, maxLen)
PicGetDescription(ctrl, description, maxLen)Returns: SalNumber.
PicGetImage(ctrl, buffer, type)
PicGetImage(ctrl, buffer, type)Returns: SalNumber.
PicGetImage(ctrl, buffer, type)
PicGetImage(ctrl, buffer, type)Returns: SalNumber.
PicGetString(ctrl, format, buffer)
PicGetString(ctrl, format, buffer)Returns: SalNumber.
PicGetString(ctrl, format, buffer)
PicGetString(ctrl, format, buffer)Returns: SalNumber.
PicSet(ctrl, resourceType, format)
PicSet(ctrl, resourceType, format)Inserts a resource into a picture.
format
The resource type. If you specify zero, the resource type will be determined. Otherwise, specify one of these values: PIC_FormatBitmapPIC_FormatIcon
Returns: SalBoolean. true if the function succeeds and false if it fails.
PicSetFile(ctrl, fileName)
PicSetFile(ctrl, fileName)Inserts a file's contents into a picture.
Returns: SalBoolean. true if the function succeeds and false if it fails.
Function SalPicSetFile() loads most picture formats. The file extension must match the format type. Valid files are of the following types:. .bmp(Windows bitmap files), .dib(Device Independent bitmaps, a holdover from earlier versions of Windows), .pcx, .tif(Tagged Image File Format(TIFF) files), .wmf(Windows MetaFile format), .gif(Graphics Interchange Format files).jpg(Joint Photographic Experts Group (JPEG) files)
PicSetFit(ctrl, fit, scaleWidth, scaleHeight)
PicSetFit(ctrl, fit, scaleWidth, scaleHeight)Sets the fit for a picture.
Returns: SalBoolean. true if the function succeeds and false if it fails.
PicSetHandle(ctrl, type, handle)
PicSetHandle(ctrl, type, handle)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.
type
Set this to PIC_FormatIcon if nHandle is an HICON or to PIC_FormatBitmap if nHandle is an HBITMAP.
Returns: SalBoolean. true if this function succeeds and false otherwise.
PicSetImage(ctrl, buffer, type)
PicSetImage(ctrl, buffer, type)Inserts the contents of a picture to an image without the image header.
type
Receives the format of the picture contents: PIC_ImageTypeNonePIC_ImageTypeBMPPIC_ImageTypeICONPIC_ImageTypeWMFPIC_ImageTypeTIFFPIC_ImageTypePCXPIC_ImageTypeGIFPIC_ImageTypeJPEGPIC_ImageTypeNuVEQ
Returns: SalBoolean. true if the function succeeds and false if it fails.
PicSetString(ctrl, format, buffer)
PicSetString(ctrl, format, buffer)Inserts the contents of a string into a picture.
Returns: SalBoolean.
PicSetString(ctrl, format, buffer)
PicSetString(ctrl, format, buffer)Inserts the contents of a binary buffer into a picture.
Returns: SalBoolean. true if the function succeeds and false if it fails.
PixelsToFormUnits(ctrl, numPixels, vertical)
PixelsToFormUnits(ctrl, numPixels, vertical)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.
vertical
If the form units are on the X axis, set this parameter to false. If the form units are on the Y axis, set this parameter to true.
Returns: SalNumber. the number of form units returned if the function call is successful. Returns zero (0) if ctrl is invalid.
PostMsg(ctrl, msg, wParam, lParam)
PostMsg(ctrl, msg, wParam, lParam)Posts the specified message to a window by adding msg to ctrl's message queue.
wParam
The wParam for the message. A generic parameter used to hold numeric information useful for messages processing.
lParam
The lParam for the message.A generic parameter used to hold numeric information useful for messages processing.
Returns: SalBoolean. true if the function succeeds and false if it fails.
PrtExtractRect(lParam, left, top, right, bottom)
PrtExtractRect(lParam, left, top, right, bottom)Returns: SalBoolean.
PrtGetDefault(device, driver, port)
PrtGetDefault(device, driver, port)Returns: SalBoolean.
PrtGetParmNum(parm, value)
PrtGetParmNum(parm, value)Returns: SalBoolean.
PrtPreviewForm(ctrl)
PrtPreviewForm(ctrl)Prints a form window, table window, or dialog box, including its contents and row header flags.
Returns: SalBoolean. bOk
PrtPrintForm(ctrl)
PrtPrintForm(ctrl)Prints a form window, table window, or dialog box, including its contents and row header flags.
Returns: SalBoolean. true if the function succeeds and false if it fails.
If a form window or dialog box contains a child table window, list box or combo box, only the rows on screen print. Lines, frames, and pictures print as well. Tries to print a window in the font displayed on screen.For best results, use only those fonts supported by your printer. If the window is wider or higher than the paper size, the window prints on as many pages as needed.
PrtSetDefault(device, driver, port)
PrtSetDefault(device, driver, port)Sets the default device (printer), driver, and port.
Returns: SalBoolean. true if the function succeeds and false if it fails.
NOTE: The port number in NT is a volatile value. If a network printer is deleted from the list of printers, the port number Nexx changes. Setting the port name (i.e., \PrintServer\PrinterName) for both the device and port parameters circumvents this.
PrtSetParmDefaults()
PrtSetParmDefaults()Resets print parameters back to their default values.
Returns: SalBoolean. true if the function succeeds and false if it fails.
The print parameters are a set of global variables which are initialized to default values and can be set using PrtSetParmNum, retrieved using PrtGetParmNum or reinitialized using PrtSetParmDefaults
PrtSetParmNum(parm, value)
PrtSetParmNum(parm, value)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 PrtSetParmNum, retrieved using PrtGetParmNum or reinitialized using PrtSetParmDefaults
Returns: SalBoolean. true if the function succeeds and false if it fails.
PRT_* constants: PRT_nCopyCountPRT_nDraftModePRT_nFromPagePRT_nMarginLeftPRT_nMarginTopPRT_nPrintAllPRT_nShowFormPageRectPRT_nToPage
PrtSetup(device, driver, port, activeOnly)
PrtSetup(device, driver, port, activeOnly)Returns: SalBoolean.
QueryFieldEdit(ctrl)
QueryFieldEdit(ctrl)Returns the setting of the Field Edit Flag for a data field, multi line field, combo box, table window's context row cell, or picture.
Returns: SalBoolean. true if hWndField's field edit flag is set and false otherwise.
The field edit flag is set whenever the user changes the value of an editable data field, multiline text field, or table window column. For a picture, the field edit flag is set whenever a server application is opened for editing. The field edit flag is not set if you make the change with a Set statement or a fetch from the database. This function does NOT clear the field edit flag of ctrl. Important: For some objects(such as table window scroll bars) GetType returns zero.Do not call QueryFieldEdit for any object where GetType returns zero.
Quit()
Quit()Exits an application.
Returns: SalBoolean. true if the function succeeds. False if the function fails.
ReportClose(windowReport)
ReportClose(windowReport)Closes a report window. Call this function when you want to close a report preview window.
Returns: SalBoolean. true if the function succeeds and false if windowReport is invalid.
ReportCmd(windowReport, command)
ReportCmd(windowReport, command)Sends a command to an open report window. Use ReportCmd() to control a window that displays a report.
command
The command to send to the report. Possible values include any of the RPT_Cmd* commands.
Returns: SalBoolean. true if the function succeeds and false if it fails
When you call ReportView, its second parameter contains the handle of the window in which the report displays. The application creates that window. Use ReportCmd() to send commands that control the window to Report Builder. RPT_Cmd* commands: RPT_CmdFirstPageRPT_CmdGoToPageRPT_CmdLastPageRPT_CmdNextPageRPT_CmdPrevPageRPT_CmdPrintRPT_CmdPrinterSetupRPT_CmdSizeActualRPT_CmdSizeFit
ReportCreate(fileName, variableNames, inputs, defaultReport, error)
ReportCreate(fileName, variableNames, inputs, defaultReport, error)Returns: SalBoolean.
ReportCreate(fileName, variableNames, inputs, defaultReport, error, template)
ReportCreate(fileName, variableNames, inputs, defaultReport, error, template)Returns: SalBoolean.
ReportDlgOptions(windowReport, caption, line1, line2, docName)
ReportDlgOptions(windowReport, caption, line1, line2, docName)Sets the options for the report printing dialog box.
docName
The name of the document that Print Manager displays when the output is spooled and waiting to print.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ReportGetDateTimeVar(windowReport, variableName, value)
ReportGetDateTimeVar(windowReport, variableName, value)Returns: SalBoolean.
ReportGetNumberVar(windowReport, variableName, value)
ReportGetNumberVar(windowReport, variableName, value)Returns: SalBoolean.
ReportGetObjectVar(windowReport, variableName, value)
ReportGetObjectVar(windowReport, variableName, value)Returns: SalBoolean.
ReportGetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)
ReportGetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)Returns: SalBoolean.
ReportGetStringVar(windowReport, variableName, value)
ReportGetStringVar(windowReport, variableName, value)Returns: SalBoolean.
ReportPrint(owner, template, variableNames, inputs, copies, options, firstPage, lastPage, error)
ReportPrint(owner, template, variableNames, inputs, copies, options, firstPage, lastPage, error)Returns: SalWindowHandle.
ReportPrintToFile(owner, template, destFile, variableNames, inputs, copies, options, firstPage, lastPage, rtfFormat, error)
ReportPrintToFile(owner, template, destFile, variableNames, inputs, copies, options, firstPage, lastPage, rtfFormat, error)Returns: SalWindowHandle.
ReportPrintToFile(owner, template, destFile, variableNames, inputs, options, firstPage, lastPage, error)
ReportPrintToFile(owner, template, destFile, variableNames, inputs, options, firstPage, lastPage, error)Returns: SalWindowHandle.
ReportReset(windowReport)
ReportReset(windowReport)Re-populates the report window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
This function re-sends the SAM_ReportFetchInit message, and one or more SAM_ReportFetchNext messages to populate the report window with the new data.
ReportSetDateTimeVar(windowReport, variableName, value)
ReportSetDateTimeVar(windowReport, variableName, value)Sets the value of a date/time report variable.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ReportSetNumberVar(windowReport, variableName, value)
ReportSetNumberVar(windowReport, variableName, value)Sets the value of a numeric report variable.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ReportSetObjectVar(windowReport, variableName, value)
ReportSetObjectVar(windowReport, variableName, value)Sets the value of an object report variable.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ReportSetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)
ReportSetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)Sets the printer properties at runtime. This function should be called while processing the SAM_ReportStart event.
printerName
Friendly name of the printer. Pass STRING_Null or an empty string if you do not want to switch the printer.
orientation
Paper Orientation. Use one of the following constants: * RPT_Portrait for portrait mode. * RPT_Landscape for landscape mode. * Use -1 if you do not want to change the orientation.
width
Paper width in milli-inches. This value is ignored for all paper types except for RPT_PaperCustom.
height
Paper height in milli-inches. This value is ignored for all paper types except for RPT_PaperCustom.
Returns: SalBoolean. true if the function succeeds and false if it fails.
RPT_Paper* constants: RPT_PaperA3RPT_PaperA3RPT_PaperA4RPT_PaperA5RPT_PaperB5RPT_PaperLegalRPT_PaperLetterRPT_PaperTabloidRPT_PaperCustom
ReportSetStringVar(windowReport, variableName, value)
ReportSetStringVar(windowReport, variableName, value)Sets the value of a string report variable.
Returns: SalBoolean. true if the function succeeds and false if it fails.
ReportTableCreate(fileName, table, error)
ReportTableCreate(fileName, table, error)Returns: SalBoolean.
ReportTableCreate(fileName, table, error, template)
ReportTableCreate(fileName, table, error, template)Returns: SalBoolean.
ReportTablePrint(table, template, paramArray, error)
ReportTablePrint(table, template, paramArray, error)Returns: SalWindowHandle.
ReportTableView(table, parent, template, error)
ReportTableView(table, parent, template, error)Returns: SalWindowHandle.
ReportView(owner, parent, template, variableNames, inputs, flags)
ReportView(owner, parent, template, variableNames, inputs, flags)Returns: SalWindowHandle.
ResolveType(asm, typeName)
ResolveType(asm, typeName)Finds the type in any loaded assembly. The first specified assembly argument has the precedence.
Returns: Type.
ScrollGetPos(ctrl, pos)
ScrollGetPos(ctrl, pos)Returns: SalBoolean.
ScrollGetRange(ctrl, min, max, line, page)
ScrollGetRange(ctrl, min, max, line, page)Returns: SalBoolean.
ScrollSetPos(ctrl, pos)
ScrollSetPos(ctrl, pos)Sets the scrollbar's value.
pos
The scroll bar position. If this value is outside the scroll bar's range, sets the scroll bar position to the scroll range minimum or the scroll range maximum, depending on whether pos is below or above the range.
Returns: SalBoolean. true if the function succeeds and false if it fails.
This function is equivalent to using a Set statement to assign a value to the scroll bar.
ScrollSetRange(ctrl, min, max, line, page)
ScrollSetRange(ctrl, min, max, line, page)Sets a scroll bar's range, line increment, and page increment.
line
The number of units to increment or decrement the scroll bar when the user clicks the scroll bar arrow.
page
The number of units to increment or decrement the scroll bar when the user clicks either side of the scroll box.
Returns: SalBoolean. true if the function succeeds and false if it fails.
When the scroll bar is created, it is assigned these values: Minimum scroll position: 0 Maximum scroll position: 100 Line Increment: 1 Page Increment: 10 If the scroll bar's position before calling this function is outside the range specified by min and max , its position changes to fall within the new range. min and max must lie within the range of -32,767 to 32,767.
SendClassMessage(message, wParam, lParam)
SendClassMessage(message, wParam, lParam)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.
Returns: SalNumber. the message return value. If the message has no return, returns zero (0).
Note: This function cannot be used against a Visual Toolchest or QuickObject class when building to a .NET build target.
SendClassMessageNamed(type, message, wParam, lParam)
SendClassMessageNamed(type, message, wParam, lParam)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.
wParam
The wParam for the message. A generic parameter used to hold numeric information useful for messages processing.
lParam
The lParam for the message.A generic parameter used to hold numeric information useful for messages processing.
Returns: SalNumber. the message return value. If the message has no return, returns zero (0).
Use this function instead of SendClassMessage with a class that is the result of multiple inheritance. It lets you specify which base class message action you want to execute. type must be a direct base class of the class from which this call is made. Note: This function cannot be used against a Visual Toolchest or QuickObject class when building to a.NET build target.
SendMsg(ctrl, message, wParam, lParam)
SendMsg(ctrl, message, wParam, lParam)Sends the specified message to a window. SendMsg does not return until the processing for the message is complete.
wParam
The wParam for the message. A generic parameter used to hold numeric information useful for messages processing.
lParam
The lParam for the message.A generic parameter used to hold numeric information useful for messages processing.
Returns: SalNumber. the message return value. If the message has no return, returns zero (0).
SendMsgToChildren(ctrl, message, wParam, lParam)
SendMsgToChildren(ctrl, message, wParam, lParam)Sends a message to all child items of a form window, dialog box, table window, or MDI window.
wParam
The wParam for the message. A generic parameter used to hold numeric information useful for messages processing.
lParam
The lParam for the message.A generic parameter used to hold numeric information useful for messages processing.
Returns: SalBoolean. true if the function succeeds and false if it fails.
SendValidateMsg()
SendValidateMsg()Sends a SAM_Validate message to the object with the focus data field, multi line field, or table window column if it was edited and sets the wParam and lParam message variables to zero (0).
Returns: SalNumber. VALIDATE_Cancel, VALIDATE_Ok, or VALIDATE_OkClearFlag
Call this function to force field validation before processing a menu pick. SAM_Validate message is not automatically sent on a menu pick.
SetBufferLength(buffer, length)
SetBufferLength(buffer, length)Returns: SalBoolean.
SetBufferLength(str, length)
SetBufferLength(str, length)Returns: SalBoolean.
SetDefButton(ctrl)
SetDefButton(ctrl)Sets the default push button of a form window or dialog box.
Returns: SalBoolean. true if the function succeeds and false if ctrl is not a valid button.
When this function returns, the default push button gets the focus only if the focus was on one of the push buttons before you called SetDefButton.
SetErrorInfo(code, desc, helpfileName, helpContext)
SetErrorInfo(code, desc, helpfileName, helpContext)Sets COM error information.
helpfileName
The fully qualified drive, path, and file name of a help file with more information about the error.
helpContext
The help context identifier of a topic in the help file. This field is ignored when helpfileName is empty.
Returns: SalBoolean. true if the function succeeds and false if it fails.
If an error occurs during a method, you can call SetErrorInfo() to set standard error information. This function does not halt processing. This function should be the last statement that the method executes.
SetFieldEdit(ctrl, set)
SetFieldEdit(ctrl, set)Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.
ctrl
The data field, multiline text field, table window column, or picture on which to execute the call.
Returns: SalBoolean. true if the function succeeds and false if it fails.
The Field Edit Flag is set whenever the user changes the value of a data field, multiline field, combo box or table window column. For a picture, the field edit flag is set whenever a server application is opened for editing. The field edit flag is not set if you make the change with a Set statement or a fetch from a database.
SetFocus(ctrl)
SetFocus(ctrl)Sets the focus to a specified window.
Returns: SalWindowHandle. the window that previously had the focus.
Warning: You cannot call SalSetFocus in SAM_KillFocus processing.
SetMaxDataLength(ctrl, length)
SetMaxDataLength(ctrl, length)Sets a limit on the number of characters that a user can enter into a data field, multi line text field, or table window column.
Returns: SalBoolean. true if the function succeeds and false if it fails.
SetProfileString(section, entry, value, fileName)
SetProfileString(section, entry, value, fileName)Set the value of an entry in the specified section of an initialization file or registry.
fileName
The name of the initialization file or company name depending on the settings made using the UseRegistry function.
Returns: SalBoolean. true if the function succeeds and false if it fails.
SetWindowLabelText(ctrl, text)
SetWindowLabelText(ctrl, text)Sets the text of the label associated to a control. Important: The label control does not require a mnemonic for the function to operate.
Returns: SalBoolean. true if the function succeeds and false if it fails.
SetWindowLoc(ctrl, x, y)
SetWindowLoc(ctrl, x, y)Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean. true if the function succeeds and false if ctrl is not a valid window.
SetWindowSize(ctrl, width, height)
SetWindowSize(ctrl, width, height)Resizes a window.
Returns: SalBoolean. true if the window is successfully resized, and false if ctrl is an invalid window handle.
SetWindowText(ctrl, text)
SetWindowText(ctrl, text)Sets the text of a window to a specified string.
Returns: SalBoolean. true if the function succeeds and false if it fails.
A window's text is the title of a form window, modeless dialog box, table window, radio button, check box, or push button. For a data field or table window column, the text is the object's value in string form, regardless of the object's data type. For a combo box, the text is the contents of the editable data field portion.If the combo box is not editable, it tries to set the list selection to the item that matches the specified string. This latter statement is true for list boxes as well. SetWindowText clears the field edit flag.
ShowWindow(ctrl)
ShowWindow(ctrl)Makes a window visible.
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.
ShowWindowAndLabel(ctrl)
ShowWindowAndLabel(ctrl)Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.
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.
StartTrace(outputType, traceFile, clearExisting)
StartTrace(outputType, traceFile, clearExisting)Begins tracing.
Returns: SalBoolean.
StaticFirst(form)
StaticFirst(form)Returns a "handle" to the first static on a window
Returns: SalNumber.
StaticGetLabel(ctrl)
StaticGetLabel(ctrl)Gets the static "handle" if the label for a specified control
Returns: SalNumber.
StaticGetLoc(form, handle, x, y)
StaticGetLoc(form, handle, x, y)Returns: SalBoolean.
StaticGetSize(form, handle, width, height)
StaticGetSize(form, handle, width, height)Returns: SalBoolean.
StaticHide(form, handle)
StaticHide(form, handle)Hides a static
Returns: SalBoolean.
StaticIsVisible(form, handle)
StaticIsVisible(form, handle)Determines whether a static is visible.
Returns: SalBoolean.
StaticNext(form, handle)
StaticNext(form, handle)Returns a "handle" to the last static on a window
Returns: SalNumber.
StaticSetLoc(form, handle, x, y)
StaticSetLoc(form, handle, x, y)Sets the location coordinates of a static
Returns: SalBoolean.
StaticSetSize(form, handle, width, height)
StaticSetSize(form, handle, width, height)Sets the size of a static
Returns: SalBoolean.
StaticShow(form, handle)
StaticShow(form, handle)Shows a static
Returns: SalBoolean.
StatusGetText(ctrl, text, maxLen)
StatusGetText(ctrl, text, maxLen)Returns: SalNumber.
StatusSetText(ctrl, text)
StatusSetText(ctrl, text)Displays specified text in the status bar of a top-level or MDI window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
StatusSetVisible(ctrl, show)
StatusSetVisible(ctrl, show)Shows or hides the status bar on a top-level or MDI window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
StrCompress(str)
StrCompress(str)Returns: SalBoolean.
StrFirstChar(str, charCode)
StrFirstChar(str, charCode)Returns: SalBoolean.
StrGetBufferLength(str)
StrGetBufferLength(str)Returns the current buffer length of a string.
Returns: SalNumber. the length of str's buffer.
StrIsValidCurrency(money, precision, scale)
StrIsValidCurrency(money, precision, scale)Verifies that a string represents a valid currency value.
Returns: SalBoolean.
StrIsValidDateTime(str)
StrIsValidDateTime(str)Verifies that string represents a valid date/time value.
Returns: SalBoolean. true if str contains a valid date/time value and false otherwise.
StrIsValidDecimal(str, precision, scale)
StrIsValidDecimal(str, precision, scale)Verifies that an entire character string represents a valid decimal value.
Returns: SalBoolean. true if str contains a number of the specified precision and scale, and false if str 's value does not match the parameter specifications.
StrIsValidIdentifierName(str)
StrIsValidIdentifierName(str)Returns TRUE if the string is a valid identifier.
Returns: SalBoolean.
StrIsValidNumber(str)
StrIsValidNumber(str)Verifies that a string represents a valid number value. Valid numbers are integers or floating point numbers, negative and positive.
Returns: SalBoolean. true if str contains a valid number and false otherwise.
StrLeft(source, length, target)
StrLeft(source, length, target)Returns: SalNumber.
StrLeftX(source, length)
StrLeftX(source, length)Returns a substring of a specified length starting at position zero.
Returns: SalString. the substring.
StrLength(str)
StrLength(str)Returns a string's length.
Returns: SalNumber. the length of str
StrLop(str)
StrLop(str)Returns: SalNumber.
StrLower(source, target)
StrLower(source, target)Returns: SalNumber.
StrLowerX(source)
StrLowerX(source)Converts a string to lowercase.
Returns: SalString. the lowercase string.
StrMid(source, startPos, length, target)
StrMid(source, startPos, length, target)Returns: SalNumber.
StrMidX(source, startPos, length)
StrMidX(source, startPos, length)Returns a substring, starting at a specified position and containing a specified number of characters.
Returns: SalString. the substring.
StrProper(source, target)
StrProper(source, target)Returns: SalNumber.
StrProperX(source)
StrProperX(source)Converts a string to a proper name.
Returns: SalString. the converted string.
StrRepeat(source, times, target)
StrRepeat(source, times, target)Returns: SalNumber.
StrRepeatX(source, times)
StrRepeatX(source, times)Concatenates a string with itself a specified number of times.
Returns: SalString. The new string.
StrReplace(source, startPos, length, replace, target)
StrReplace(source, startPos, length, replace, target)Returns: SalNumber.
StrReplaceX(source, startPos, length, replace)
StrReplaceX(source, startPos, length, replace)Returns: SalString.
StrRight(source, length, target)
StrRight(source, length, target)Returns: SalNumber.
StrRightX(source, length)
StrRightX(source, length)Returns a string of specified length, starting with the last character in the string.
Returns: SalString. The new string.
StrScan(str1, str2)
StrScan(str1, str2)Returns the offset of a specified substring. If there is more than one instance of the string being searched for, only the offset of the first instance is returned. Case is disregarded in the search.
Returns: SalNumber. a number that indicates the offset (0 origin) of str2 in str1 . If str2 is not found in str1 , returns -1.
You can use pattern matching characters. The percent character (%) matches any set of characters. The underscore character (_) matches any single character. The use of a backslash() with SalStrScan differs when searching for a backslash, percent, or underscore character. Its usage also differs depending on whether or not the second parameter is a string literal. When searching for a backslash and strString2 is a string literal, you need four backslashes:StrScan( 'This is a \', '\\' ) When searching for a percent character or an underscore character and strString2 is a string literal, you need two backslashes: StrScan( 'This is a %', '\%' ) StrScan( 'This is an ', '\' ) Even if str2 is not a string literal, you need a single backslash to search for a percent character or an underscore.
StrSetBufferLength(str, length)
StrSetBufferLength(str, length)Returns: SalBoolean.
StrToDate(str)
StrToDate(str)Converts a string to a date/time value. This function uses the system date format to convert a date string. If you want to be format independent, use DateConstruct.
Returns: SalDateTime. the date/time value converted from str
StrTokenize(source, startDel, endDel, target)
StrTokenize(source, startDel, endDel, target)Parses a string into substrings (tokens) based on specified start and end delimiters. Delimiters are used to recognize the beginning and end of each substring.
startDel
A string that contains the start delimiter character. Pass an empty string ('') to specify the lack of a start delimiter.
endDel
A string that contains the end delimiter character. Pass an empty string ('') to specify the lack of an end delimiter.
Returns: SalNumber. the number of substrings created. Returns zero (0) if no substrings are created, or if an error occurs.
Interprets the first non-start delimiter character as the beginning of a substring, and skips any start delimiters that precede this character. For example, if '!' is a start delimiter, the strings 'Hello' and '!!!Hello' produce the same token: 'Hello'. If the first non-start delimiter character is an end delimiter character, it is interpreted as a null substring. This is useful for comma-separated data where ',' is an end delimiter. For example, the records 'data1,data2,,data4' and ',data2,data3,data4' have four tokens each, one of which is null. Once the beginning of a substring is found, it interprets all characters that follow as elements of the substring until it finds an end delimiter. For example, if '!' is a start delimiter and '?' is an end delimiter, the string 'abc!def?ghi!' produces the tokens: 'abc!def' and 'ghi!'. Although the exclamation point is a start delimiter, they are correctly interpreted as elements of the substring.
StrToNumber(str)
StrToNumber(str)Converts a string to a number.
Returns: SalNumber. the number resulting from the conversion.
StrTrim(source, target)
StrTrim(source, target)Returns: SalNumber.
StrTrimX(source)
StrTrimX(source)Strips leading and trailing blanks and compresses multiple spaces and tabs within a string to single spaces.
Returns: SalString. the new string.
StrUncompress(str)
StrUncompress(str)Returns: SalBoolean.
StrUpper(source, target)
StrUpper(source, target)Returns: SalNumber.
StrUpperX(source)
StrUpperX(source)Converts a string to uppercase.
Returns: SalString. the uppercase string.
TabAddPage(control, pageIndex, pageName)
TabAddPage(control, pageIndex, pageName)Adds a tab page at a valid tab set index position.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabAddPageEx(control, pageIndex, pageName, imageFile, tooltip)
TabAddPageEx(control, pageIndex, pageName, imageFile, tooltip)Adds a tab page at a valid tab set index position. You can include an image and a tool tip.
pageIndex
Indicates a zero-based page index. The new page will be inserted after the page indicated by pageIndex.
Returns: SalBoolean. true if the function succeeds; false if it fails.
TabAssociateChild(control, pageIndex, child)
TabAssociateChild(control, pageIndex, child)Associates a child to a tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabAttachWindow(control, pageIndex, form)
TabAttachWindow(control, pageIndex, form)Assigns a child window created at runtime to the specified tab page as its container window. You can programmatically create a Form Window or Dialog Box as child and assign it to a tab page by using this function.
Returns: SalBoolean. the Window to which the child window was previously attached. This function returns hWndNULL if function fails.
Note:
The child window( form ) will resize to fill the tab page, even if form is the handle for a single object. If you want several objects on the tab page, use a parent window that contains the desired objects
When creating the form or dialog box to associate with the tab, make sure to use the tab bar as the parent window in the call to CreateWindowEx and/or the nFlag parameter with CREATE_AsChild
If a top level window has Accessories Enabled and it was not created with the tab bar it is going to be associated with as the parent, and the call will fail and return hWndNULL
TabDetachWindow(control, pageIndex)
TabDetachWindow(control, pageIndex)Detaches a child window from the specified tab control. The tab page will be associated to a new default tab control.
Returns: SalWindowHandle. The tab control to which the tab page was previously attached.
TabDisablePage(control, pageIndex)
TabDisablePage(control, pageIndex)Disables a tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabDisassociateChild(control, pageIndex, child)
TabDisassociateChild(control, pageIndex, child)Disassociates a child with a tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabEnablePage(control, pageIndex)
TabEnablePage(control, pageIndex)Enables a tab page
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabGetActivePage(control)
TabGetActivePage(control)Gets the current active tab page.
Returns: SalNumber. Integer that specifies the current active tab page. For the first tab page, pageIndex = 0.
TabGetPageIndex(control, pageName)
TabGetPageIndex(control, pageName)Gets the tab page index as specified by the tab name.
Returns: SalNumber. Integer that specifies the tab index of a particular tab page. For the first tab page, pageIndex = 0.
TabGetPageName(control, pageIndex)
TabGetPageName(control, pageIndex)gets the name of the tab page (not the title that appears on the tab page at runtime).
Returns: SalString. The name of the tabpage.
TabGetPageTitle(control, pageIndex)
TabGetPageTitle(control, pageIndex)Gets the tab page title as specified by the tab index.
Returns: SalString. String that specifies the tab name of a particular tab page index.
TabGetPageWindow(control, pageIndex)
TabGetPageWindow(control, pageIndex)Gets the window handle of the specified tab page.
Returns: SalWindowHandle. the window handle of the specified tab page.
TabGetTooltip(control, pageIndex, tooltip, maxLength)
TabGetTooltip(control, pageIndex, tooltip, maxLength)Returns: SalNumber.
TabHidePage(control, pageIndex)
TabHidePage(control, pageIndex)Hides a tab page and all controls within that page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabHideStrip(control)
TabHideStrip(control)Hides the tab page selector inside the specified tab control. While the tab selector strop is hidden, you can change the active tab page by using TabSetActivePage.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabPageCount(control)
TabPageCount(control)Returns the number of tab pages.
Returns: SalNumber. The number of tabs in the tabset.
TabRemovePage(control, pageIndex)
TabRemovePage(control, pageIndex)Removes a tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabRenamePage(control, pageIndex, pageName)
TabRenamePage(control, pageIndex, pageName)Renames a tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabSetActivePage(control, pageIndex)
TabSetActivePage(control, pageIndex)Activates a tab specified by a particular tab index.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabSetPageTitle(control, pageIndex, pageTitle)
TabSetPageTitle(control, pageIndex, pageTitle)Sets the title of the specified tab page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabSetTooltip(control, pageIndex, tooltip)
TabSetTooltip(control, pageIndex, tooltip)Sets the tool tip text on the specified tab page. Tool tip text appears only on tab selector, not on a tab container window.
Returns: SalBoolean. a number that indicates the length of tooltip
TabShowPage(control, pageIndex)
TabShowPage(control, pageIndex)Shows a tab page specified by the pageIndex and all controls within that page.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabShowStrip(control)
TabShowStrip(control)Shows the tab page selector inside the specified tab control.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TabUpdate(control)
TabUpdate(control)Updates the Tab bar after a TabAssociateChild or TabDisassociateChild is called.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TBarSetVisible(ctrl, show)
TBarSetVisible(ctrl, show)Shows or hides the tool bar on a top-level or MDI window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TblAnyRows(table, flagsOn, flagsOff)
TblAnyRows(table, flagsOn, flagsOff)Determines whether any rows in the specified table window match certain flags.
Returns: SalBoolean. true if any of the table window's or grid's rows have any of the flagsOn flags and none of the flagsOff flags.
If you set flagsOn to zero (0) and flagsOff to zero (0), TblAnyRows returns true if the table window or grid contains any rows at all, regardless of their flags. Row Flag Constants: ROW_EditedROW_HiddenROW_HideMarksROW_MarkDeletedROW_NewROW_SelectedROW_UnusedFlag1ROW_UnusedFlag2
TblClearSelection(table)
TblClearSelection(table)Deselects all rows of a table window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TblColumnAverage(table, columnId, flagsOn, flagsOff)
TblColumnAverage(table, columnId, flagsOn, flagsOff)Computes the average of all column values or only specified column values in a table window.
flagsOn
The flags that the row should have. You can combine ROW* flags using the OR (|) operator.
flagsOff
The flags that the row should not have. You can combine ROW* flags using the OR (|) operator:
Returns: SalNumber. the average of all column values or only specified column values in a table window or grid. Returns zero (0) if an error occurs.
TblColumnSum(table, columnId, flagsOn, flagsOff)
TblColumnSum(table, columnId, flagsOn, flagsOff)Computes the sum of all column values or only specified column values in a table window.
Returns: SalNumber. The sum of all column values or only specified column values in a table window or grid. Returns zero (0) if an error occurs.
Use row flag constants to specify the rows to use to compute the sum. For example, you can choose to sum only the values of modified rows.
TblCopyRows(table, flagsOn, flagsOff)
TblCopyRows(table, flagsOn, flagsOff)Copies the contents of the specified table window rows to the Clipboard in text format.
Returns: SalBoolean. true if any of the table window or grid rows are copied to the Clipboard and false if no rows matched the indicated flags, or if none of the matched rows could be copied to the Clipboard.
In the Clipboard, columns are delimited by TAB characters and rows are delimited by end-of-line characters. Set flagsOn to zero (0) and flagsOff to zero (0) to copy the entire table. The copy stops, without indicating a failure, after copying 64 Kbytes of text. Each individual column value is limited to 512 bytes of text. Row Flag Constants: ROW_EditedROW_HiddenROW_HideMarksROW_MarkDeletedROW_NewROW_SelectedROW_UnusedFlag1ROW_UnusedFlag2
TblCreateColumn(table, columnPos, displayWidth, maxChars, title)
TblCreateColumn(table, columnPos, displayWidth, maxChars, title)Creates a table window column of string data type at runtime. When you return to design mode, the column is destroyed.
Returns: SalNumber. the Column Identifier of the new column. Returns negative one (-1) if an error occurs.
TblCreateColumnEx(table, columnPos, displayWidth, title, maxChars, dataType)
TblCreateColumnEx(table, columnPos, displayWidth, title, maxChars, dataType)Creates a table window column using a given data type at runtime. Allowed types are DT_String, DT_Number and DT_DateTime. When you return to design mode, the column is destroyed.
dataType
One of the datatype constants: DT_Boolean, DT_DateTimeDT_LongStringDT_NumberDT_String
Returns: SalNumber. the Column Identifier of the new column. Returns negative one (-1) if an error occurs
TblCreateColumnFromClass(table, className, position)
TblCreateColumnFromClass(table, className, position)Uses the specified class as a template to create a new column in a SalTableWindow.
position
The position in the grid or table where the new column where be inserted. 1 is the left-most position. -1 indicates to append the column to the end of the table.
Returns: SalWindowHandle. The new column. NULL if an error occurs.
TblDefineCheckBoxColumn(column, flags, checkedValue, uncheckedValue)
TblDefineCheckBoxColumn(column, flags, checkedValue, uncheckedValue)Define a column as a check box.
Returns: SalBoolean.
TblDefineDropDownListColumn(column, flags, lines)
TblDefineDropDownListColumn(column, flags, lines)Define a column as a drop down list.
Returns: SalBoolean.
TblDefinePopupEditColumn(column, flags, lines)
TblDefinePopupEditColumn(column, flags, lines)Define a column as a popup edit window.
Returns: SalBoolean.
TblDefineRowHeader(table, title, width, flags, column)
TblDefineRowHeader(table, title, width, flags, column)Defines the appearance and behavior of a table window's row header.
flags
The row header attributes. You can combine these flags using the OR (|) operator. Possible values include: TBL_RowHdr_VisibleTBL_RowHdr_MarkEditsTBL_RowHdr_ShareColorTBL_RowHdr_Sizable
Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.
The row header is a non-editable area on the left edge of a table window or grid that displays information that stays displayed even when a user scrolls horizontally. A typical use of a row header is the display of row numbers.
TblDefineSplitWindow(table, rowsLowerHalf, dragAdjust)
TblDefineSplitWindow(table, rowsLowerHalf, dragAdjust)Splits a table window horizontally.
rowsLowerHalf
The number of rows to make visible in the lower half of the split window. If you specify zero (0), the table window is not split.
dragAdjust
Specify whether (true) or not (false) to let the user drag-adjust the visible rows in both halves of a split window.
Returns: SalBoolean. true if the function succeeds and false if it fails.
TblDeleteRow(table, row, flag)
TblDeleteRow(table, row, flag)Deletes a row from a table window but not from the database.
flag
A constant used to coordinate a delete from the table window with a with a delete from a SQLBase result set. This parameter can be one of these values: TBL_AdjustTBL_NoAdjust
Returns: SalBoolean. true if the function succeeds and false if it fails.
TblDeleteSelected(table, sql)
TblDeleteSelected(table, sql)Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
Returns: SalBoolean. true if the function succeeds and false if table or sql is invalid.
You must prepare or retrieve the SQL DELETE statement before calling this function. As each row is deleted from the database, SQLWindows deletes it from the table window or grid display. This function does not perform a COMMIT. You must perform a COMMIT to ensure that the deletions are not lost in the case of a rollback.
TblDeleteSelected(table, sql, errorHandler)
TblDeleteSelected(table, sql, errorHandler)Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
Returns: SalBoolean. true if this function succeeds and false if it fails.
You must prepare or retrieve the SQL DELETE statement before calling this function. As each row is deleted from the database, SQLWindows deletes it from the table window or grid display. This function does not perform a COMMIT. You must perform a COMMIT to ensure that the deletions are not lost in the case of a rollback.
TblDestroyColumns(table)
TblDestroyColumns(table)Destroys all automatic columns created by SalTblCreateColumn or SalTblPopulate at runtime. This function only works on table windows that contain only automatic columns.
Returns: SalBoolean. true if the function succeeds and false if table is invalid or the table window or grid contains non-automatic columns (columns created at design time).
TblDoDeletes(table, sql, flagsOn, errorHandler)
TblDoDeletes(table, sql, flagsOn, errorHandler)Applies a SQL DELETE statement to all table window rows that have flagsOn flags.
flagsOn
Row flags are used to determine which rows to delete. You can specify either of these flags:ROW_MarkDeletedROW_Selected
Returns: SalBoolean. true if any rows are deleted and false otherwise. Returns false if table or sql is invalid.
TblDoDeletes(table, sql, flagsOn)
TblDoDeletes(table, sql, flagsOn)Applies a SQL DELETE statement to all table window rows that have flagsOn flags.
flagsOn
Row flags are used to determine which rows to delete. You can specify either of these flags:ROW_MarkDeletedROW_Selected
Returns: SalBoolean. true if any rows are deleted and false otherwise. Returns false if table or sql is invalid.
As each row is deleted from the database, SQLWindows deletes it from the table window or grid display. This function does not perform a COMMIT. You must perform a COMMIT to ensure that the deletions are not lost in the case of a rollback.
TblDoInserts(table, sql, clearFlags)
TblDoInserts(table, sql, clearFlags)Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
clearFlags
Whether to reset the ROW New flag. If TRUE, the ROW New flag of each inserted row is cleared; if FALSE, the ROW New flag of each inserted row is not cleared.. This is useful for error handling; if an error occurs, you can rollback the transaction and try again.
Returns: SalBoolean. true if the function succeeds and false if it does nit.
You must prepare the SQL INSERT statement before calling this function. This function does not perform a COMMIT. You must perform a COMMIT to ensure that insertions are not lost in the case of a rollback.
TblDoInserts(table, sql, clearFlags, errorHandler)
TblDoInserts(table, sql, clearFlags, errorHandler)Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
Returns: SalBoolean.
TblDoUpdates(ctrl, sql, clearFlags)
TblDoUpdates(ctrl, sql, clearFlags)Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
Returns: SalBoolean.
TblDoUpdates(table, sql, clearFlags, errorHandler)
TblDoUpdates(table, sql, clearFlags, errorHandler)Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
Returns: SalBoolean.
TblFetchRow(table, row)
TblFetchRow(table, row)Sends a SAM_FetchRow message to a table window if the row you specify is not currently in the table window cache.
Returns: SalNumber.
TblFindNextRow(table, row, flagsOn, flagsOff)
TblFindNextRow(table, row, flagsOn, flagsOff)Returns: SalBoolean.
TblFindPrevRow(table, row, flagsOn, flagsOff)
TblFindPrevRow(table, row, flagsOn, flagsOff)Returns: SalBoolean.
TblGetColumnText(table, columnId, text)
TblGetColumnText(table, columnId, text)Returns: SalBoolean.
TblGetColumnTitle(column, text, maxLen)
TblGetColumnTitle(column, text, maxLen)