Sal

PPJ.Runtime.Sal

Namespace: PPJ.Runtime

Assembly: PPJ.Web.49 (4.9.0.0)

Contains all Sal.* static functions.

C#

public class Sal

VB.NET

Public Class Sal

Properties

Interpreter

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

SalReportType

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

Methods

Abort(exitCode)

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

Parameter	Type	Description
exitCode	SalNumber

Returns: SalBoolean.

AppDisable()

Disables input to all open forms.

Returns: SalBoolean.

AppEnable()

Enables input to all open forms that were disabled.

Returns: SalBoolean.

AppFind(name, activate)

Finds a visible top-level window.

Parameter	Type	Description
name	SalString
activate	SalBoolean

Returns: SalWindowHandle.

ArrayAvg(array)

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

Parameter	Type	Description
array	SalArray<SalNumber>	The name of an array of numbers.

Returns: SalNumber. nAvg

ArrayDimCount(array, dim)

Parameter	Type	Description
array	SalArray
dim	SalNumber&

Returns: SalBoolean.

ArrayGetLowerBound(array, dim, bound)

Parameter	Type	Description
array	SalArray
dim	SalNumber
bound	SalNumber&

Returns: SalBoolean.

ArrayGetUpperBound(array, dim, bound)

Parameter	Type	Description
array	SalArray
dim	SalNumber
bound	SalNumber&

Returns: SalBoolean.

ArrayIsEmpty(array)

Determines if a dynamic array contains data.

Parameter	Type	Description
array	SalArray	The name of the array to query.

Returns: SalBoolean. bData

ArrayMax(array)

Returns the maximum value in an array of numbers.

Parameter	Type	Description
array	SalArray<SalNumber>

Returns: SalNumber.

ArrayMin(array)

Returns the minimum value in an array of numbers.

Parameter	Type	Description
array	SalArray<SalNumber>

Returns: SalNumber.

ArrayQueryBounds(array, min, max)

Parameter	Type	Description
array	SalArray
min	SalNumber&
max	SalNumber&

Returns: SalNumber.

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().

Parameter	Type	Description
array	SalArray	The name of the array to query.
lower	SalNumber	The new lower bound.
upper	SalNumber	The new upper bound or AC_Dynamic.

Returns: SalBoolean. bOk

ArraySetUpperBound(array, dim, bound)

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

Parameter	Type	Description
array	SalArray
dim	SalNumber
bound	SalNumber

Returns: SalBoolean.

ArraySum(array)

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

Parameter	Type	Description
array	SalArray<SalNumber>	The name of an array of numbers.

Returns: SalNumber. nSum

BringWindowToTop(ctrl)

Brings a window to the top of all overlapping windows.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

ClearField(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

ColorFromRGB(red, green, blue)

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

Parameter	Type	Description
red	SalNumber	A number from 0 to 255.
green	SalNumber	A number from 0 to 255.
blue	SalNumber	A number from 0 to 255.

Returns: SalNumber. colorValue

ColorGet(ctrl, colorIndex)

Gets a window's color.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
colorIndex	SalNumber

Returns: SalNumber.

ColorGetSysColor(colorIndex)

Gets a system color.

Parameter	Type	Description
colorIndex	SalNumber	The color of a part of the window, represented by one of these constants: COLOR_SysWindow COLOR_SysWindowFrame COLOR_SysWindowText

Returns: SalNumber. colorValue

ColorSet(ctrl, colorIndex, colorValue)

Sets a window's color.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
colorIndex	SalNumber
colorValue	SalNumber

Returns: SalBoolean.

ColorToRGB(colorValue, red, green, blue)

Parameter	Type	Description
colorValue	SalNumber
red	SalNumber&
green	SalNumber&
blue	SalNumber&

Returns: SalBoolean.

ColorToRGB(color, red, green, blue)

Parameter	Type	Description
color	Color
red	SalNumber&
green	SalNumber&
blue	SalNumber&

Returns: SalBoolean.

CompileAndEvaluate(sExpression, nError, nErrorPos, numReturn, sReturn, dtReturn, windowReturn, bInhibitErrors, context)

Parameter	Type	Description
sExpression	SalString
nError	SalNumber&
nErrorPos	SalNumber&
numReturn	SalNumber&
sReturn	SalString&
dtReturn	SalDateTime&
windowReturn	SalWindowHandle&
bInhibitErrors	SalBoolean
context	Object

Returns: SalNumber.

ContextBreak()

Deprecated: Use this. Not supported.

Returns: SalString.

ContextCurrent(context)

Returns an instance of SalStringContext wrapping the current context reference.

Parameter	Type	Description
context	Object

Returns: SalStringContext.

ContextMenuSetPopup(ctrl, menuName, flags)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
menuName	SalString
flags	SalNumber

Returns: SalBoolean.

ContextMenuSetPopup(ctrl, menuType, flags)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
menuType	Type
flags	SalNumber

Returns: SalBoolean.

CreateWindow(tWndToCreate, parent, parameters)

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

Parameter	Type	Description
tWndToCreate	Type
parent	Control
parameters	Object[]

Returns: SalWindowHandle.

CreateWindow(formName, parent, parameters)

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

Parameter	Type	Description
formName	SalString
parent	Control
parameters	Object[]

Returns: SalWindowHandle.

CreateWindow(formName, parent)

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

Parameter	Type	Description
formName	SalString
parent	Control

Returns: SalWindowHandle.

CreateWindowEx(tWndToCreate, parent, left, top, width, height, flags, Parameters)

Creates a form window, dialog box, or table window as a child of another form window,

Parameter	Type	Description
tWndToCreate	Type
parent	Control
left	SalNumber
top	SalNumber
width	SalNumber
height	SalNumber
flags	SalNumber
Parameters	Object[]

Returns: SalWindowHandle.

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.

Parameter	Type	Description
formName	SalString
parent	Control
left	SalNumber
top	SalNumber
width	SalNumber
height	SalNumber
flags	SalNumber

Returns: SalWindowHandle.

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.

Parameter	Type	Description
formName	SalString
parent	Control
left	SalNumber
top	SalNumber
width	SalNumber
height	SalNumber
flags	SalNumber

Returns: SalWindowHandle.

CreateWindowFromStr(formName, parent)

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

Parameter	Type	Description
formName	SalString
parent	Control

Returns: SalWindowHandle.

CursorClear(ctrl, type)

Clears a window's cursor.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
type	SalNumber

Returns: SalBoolean.

CursorSet(ctrl, resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
resourceId	SalNumber
type	SalNumber

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
fileName	SalString
type	SalNumber

Returns: SalBoolean.

CursorSetString(ctrl, blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
blob	SalString
type	SalNumber

Returns: SalBoolean.

DateConstruct(year, month, day, hour, minute, second)

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

Parameter	Type	Description
year	SalNumber
month	SalNumber
day	SalNumber
hour	SalNumber
minute	SalNumber
second	SalNumber

Returns: SalDateTime.

DateCurrent()

Returns the PC's current date/time.

Returns: SalDateTime.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalDateTime.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalDateTime.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

DateToStr(date, target)

Parameter	Type	Description
date	SalDateTime
target	SalString&

Returns: SalNumber.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalDateTime.

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.

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

DateYear(dateTime)

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

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalNumber.

DateYearBegin(dateTime)

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

Parameter	Type	Description
dateTime	SalDateTime

Returns: SalDateTime.

DestroyWindow(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

DlgChooseColor(ctrl, title, colorValue)

Parameter	Type	Description
ctrl	Control
title	SalString
colorValue	SalNumber&

Returns: SalBoolean.

DlgChooseFont(ctrl, name, size, enhancements, color)

Parameter	Type	Description
ctrl	Control
name	SalString&
size	SalNumber&
enhancements	SalNumber&
color	SalNumber&

Returns: SalBoolean.

DlgGetDockStatus(windowDlg, orientation)

Parameter	Type	Description
windowDlg	SalWindowHandle
orientation	SalNumber&

Returns: SalBoolean.

DlgOpenFile(ctrl, dialogTitle, roots, filters, filtersCount, filterIndex, fileName, filePath)

Parameter	Type	Description
ctrl	Control
dialogTitle	SalString
roots	IFileSystemProvider[]
filters	SalArray<SalString>
filtersCount	SalNumber
filterIndex	SalNumber&
fileName	SalString&
filePath	SalString&

Returns: SalBoolean.

DlgOpenFileMulti(ctrl, dialogTitle, roots, filters, filtersCount, filterIndex, fileNames, filePaths, fileCount)

Parameter	Type	Description
ctrl	Control
dialogTitle	SalString
roots	IFileSystemProvider[]
filters	SalArray<SalString>
filtersCount	SalNumber
filterIndex	SalNumber&
fileNames	SalArray`1&
filePaths	SalArray`1&
fileCount	SalNumber&

Returns: SalBoolean.

DlgSaveFile(ctrl, dialogTitle, roots, filters, filtersCount, filterIndex, fileName, filePath)

Parameter	Type	Description
ctrl	Control
dialogTitle	SalString
roots	IFileSystemProvider[]
filters	SalArray<SalString>
filtersCount	SalNumber
filterIndex	SalNumber&
fileName	SalString&
filePath	SalString&

Returns: SalBoolean.

DlgSetDockStatus(windowDlg, orientation)

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

Parameter	Type	Description
windowDlg	SalWindowHandle
orientation	SalNumber

Returns: SalBoolean.

DragDropDisableDrop()

Disables dropping while in drag mode.

Returns: SalBoolean.

DragDropEnableDrop()

Enables dropping while in drag mode.

Returns: SalBoolean.

DragDropGetDataObject()

Returns the IDataObject being dropped.

Returns: IDataObject.

DragDropGetSource(window, x, y)

Parameter	Type	Description
window	SalWindowHandle&
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

DragDropGetTarget(windowTarget, x, y)

Parameter	Type	Description
windowTarget	SalWindowHandle&
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

DragDropStart(ctrl)

Initiates drag mode.

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

DragDropStop()

Ends drag mode.

Returns: SalBoolean.

DrawMenuBar(ctrl)

Redraws the menu bar for a given form window or top-level table window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

DropFileQueryStream(nFileIndex)

Retrieves the uploaded file.

Parameter	Type	Description
nFileIndex	SalNumber	Index of the file stream to retrieve.

Returns: Stream.

DropFilesAcceptFiles(ctrl, bAccept)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
bAccept	SalBoolean

Returns: SalBoolean.

DropFilesQueryFiles(sArrayFiles)

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.

Parameter	Type	Description
sArrayFiles	SalArray<SalString>

Returns: SalNumber.

DropFilesQueryPoint(ctrl, x, y)

Parameter	Type	Description
ctrl	Control
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

EditCanCopy()

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

Returns: SalBoolean. bOk

EditCanCopyTo()

Deprecated: Not supported. There is no OLE support in .NET. Not Supported.

Returns: SalBoolean.

EditCanCut()

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

Returns: SalBoolean. bOk

EditCanPaste()

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

Returns: SalBoolean. bOk

EditCanPasteFrom()

Deprecated: Not supported. There is no OLE support in .NET. Not Supported.

Returns: SalBoolean.

EditCanUndo()

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

Returns: SalBoolean. bOk

EditClear()

Deletes selected data from the currently selected control

Returns: SalBoolean. bOk

EditCopy()

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

Returns: SalBoolean. bOk

EditCopyString(str)

Copies a string to the Clipboard as text.

Parameter	Type	Description
str	SalString	The string to copy to the Clipboard.

Returns: SalBoolean. bOk

EditCopyTo()

Deprecated: Not supported. There is no OLE support in .NET. Not Supported.

Returns: SalBoolean.

EditCut()

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

Returns: SalBoolean. bOk

EditPaste()

Pastes data from the Clipboard into the currently selected control

Returns: SalBoolean. bOk

EditPasteFrom()

Deprecated: Not supported. There is no OLE support in .NET. Not supported

Returns: SalBoolean.

EditPasteString(str)

Parameter	Type	Description
str	SalString&

Returns: SalBoolean.

EditUndo()

Undoes the last edit to the currently selected control Editing that you can undo includes inserting text, cutting text, clearing text, and pasting text.

Returns: SalBoolean.

EnableWindow(ctrl)

Enables keyboard and mouse input to a window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

EndDialog(ctrl, returnValue)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
returnValue	SalNumber

Returns: SalBoolean.

EndTrace()

Stops tracing.

Returns: SalBoolean.

FileClose(file)

Parameter	Type	Description
file	SalFileHandle&

Returns: SalBoolean.

FileCopy(sourcePath, destPath, overwrite)

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

Parameter	Type	Description
sourcePath	SalString	The full path name of the source file.
destPath	SalString	The full path name of the destination file.
overwrite	SalBoolean	Specifies whether (TRUE) or not (FALSE) to overwrite the destination file. If the destination file already exists and overwrite is FALSE, then SalFileCopy fails, and returns FILE_CopyExist. If the destination file already exists and overwrite is TRUE, then SalFileCopy succeeds and the destination file is overwritten.

Returns: SalNumber. nStatus

FileCreateDirectory(directory)

Creates a directory.

Parameter	Type	Description
directory	SalString	The full path name of the new directory.

Returns: SalBoolean. bOk

FileGetChar(file, charValue)

Parameter	Type	Description
file	SalFileHandle
charValue	SalNumber&

Returns: SalBoolean.

FileGetChar(file)

Returns the next character in an open file.

Parameter	Type	Description
file	SalFileHandle	The handle of the open file.

Returns: SalNumber. charValue

FileGetCurrentDirectory(path)

Parameter	Type	Description
path	SalString&

Returns: SalBoolean.

FileGetDateTime(fileName, dateTime)

Parameter	Type	Description
fileName	SalString
dateTime	SalDateTime&

Returns: SalBoolean.

FileGetDrive()

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

Returns: SalString. sDriveLetter

FileGetStr(file, buffer, bufferSize)

Parameter	Type	Description
file	SalFileHandle
buffer	SalString&
bufferSize	SalNumber

Returns: SalBoolean.

FileOpen(file, fileName, style)

Parameter	Type	Description
file	SalFileHandle&
fileName	SalString
style	SalNumber

Returns: SalBoolean.

FileOpen(file, fileName, style, encoding)

Parameter	Type	Description
file	SalFileHandle&
fileName	SalString
style	SalNumber
encoding	Encoding

Returns: SalBoolean.

FileOpenExt(file, fileName, style, reopen)

Deprecated: Use Sal.FileOpen().

Parameter	Type	Description
file	SalFileHandle&
fileName	SalString
style	SalNumber
reopen	SalString&

Returns: SalBoolean.

FilePutChar(file, charValue)

Writes a character to an open file.

Parameter	Type	Description
file	SalFileHandle
charValue	SalNumber

Returns: SalBoolean.

FilePutStr(file, str)

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

Parameter	Type	Description
file	SalFileHandle
str	SalString

Returns: SalBoolean.

FileRead(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle
buffer	SalString&
bufferLength	SalNumber

Returns: SalNumber.

FileRead(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle
buffer	SalBinary&
bufferLength	SalNumber

Returns: SalNumber.

FileRemoveDirectory(directory)

Deletes a directory.

Parameter	Type	Description
directory	SalString

Returns: SalBoolean.

FileSeek(file, bytes, position)

Positions the file pointer in an open file.

Parameter	Type	Description
file	SalFileHandle
bytes	SalNumber
position	SalNumber

Returns: SalBoolean.

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.

Parameter	Type	Description
path	SalString	The path name of the new current working directory.

Returns: SalBoolean. bOk

FileSetDateTime(fileName, dateTime)

Sets the modification date and time of the specified file.

Parameter	Type	Description
fileName	SalString	The name of the file whose modification date you want to set.
dateTime	SalDateTime	The modification date and time.

Returns: SalBoolean. bOk

FileSetDrive(sDriveLetter)

Sets the current disk drive to the specified drive letter.

Parameter	Type	Description
sDriveLetter	SalString	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. bOk

FileTell(file)

Returns the current position in an open file.

Parameter	Type	Description
file	SalFileHandle	The handle of an open file.

Returns: SalNumber. nPos

FileWrite(file, buffer, bufferLength)

Writes a string to an open file.

Parameter	Type	Description
file	SalFileHandle	The handle of an open file. fileFile Handle. The handle of an open file.
buffer	SalString	The string to write to file.
bufferLength	SalNumber	The number of bytes to write.

Returns: SalNumber. nResult

FileWrite(file, buffer, bufferLength)

Writes a binary buffer to an open file.

Parameter	Type	Description
file	SalFileHandle	The handle of an open file. fileFile Handle. The handle of an open file.
buffer	SalBinary	The string to write to file.
bufferLength	SalNumber	The number of bytes to write.

Returns: SalNumber. nResult

FindWindow(ctrl, windowName)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
windowName	SalString

Returns: SalWindowHandle.

FireWindowActions(ctrl, nAction, wParam, lParam)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nAction	SalNumber	Action type to send to ctrl .
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalNumber.

FireWindowActionsToChildren(ctrl, nAction, wParam, lParam)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nAction	SalNumber	Action type to send to the direct children of ctrl .
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nProfile	SalNumber

Returns: SalBoolean.

FmtFieldToStr(ctrl, text, bFormat)

Parameter	Type	Description
ctrl	Control
text	SalString&
bFormat	SalBoolean

Returns: SalBoolean.

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

Parameter	Type	Description
dateTime	SalDateTime	The date/time value to format.
sPicture	SalString	The date/time picture format.

Returns: SalString. sDateTime

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

Parameter	Type	Description
num	SalNumber	The number value to format.
sPicture	SalString	The number picture format.

Returns: SalString. sNumber

FmtGetFormat(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

FmtGetInputMask(ctrl, sMask)

Parameter	Type	Description
ctrl	Control
sMask	SalString&

Returns: SalBoolean.

FmtGetParmNum(ctrl, nParm, nValue)

Parameter	Type	Description
ctrl	Control
nParm	SalNumber
nValue	SalNumber&

Returns: SalBoolean.

FmtGetParmStr(ctrl, nParm, value)

Parameter	Type	Description
ctrl	Control
nParm	SalNumber
value	SalString&

Returns: SalBoolean.

FmtGetPicture(ctrl, sFormat)

Parameter	Type	Description
ctrl	Control
sFormat	SalString&

Returns: SalBoolean.

FmtGetProfile(ctrl)

Returns the culture profile for the specified field.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

FmtIsValidField(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

FmtIsValidInputMask(sMask)

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

Parameter	Type	Description
sMask	SalString	An input mask.

Returns: SalBoolean. bOk

FmtIsValidPicture(sFormat, nType)

Validates a numeric or date/time picture format.

Parameter	Type	Description
sFormat	SalString
nType	SalNumber

Returns: SalBoolean.

FmtKeepMask(bKeep)

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

Parameter	Type	Description
bKeep	SalBoolean

Returns: SalBoolean.

FmtSetFormat(ctrl, nFormat)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nFormat	SalNumber

Returns: SalBoolean.

FmtSetInputMask(ctrl, sMask)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
sMask	SalString

Returns: SalBoolean.

FmtSetParmNum(ctrl, nParm, nValue)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nParm	SalNumber
nValue	SalNumber

Returns: SalBoolean.

FmtSetParmStr(ctrl, nParm, value)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nParm	SalNumber
value	SalString

Returns: SalBoolean.

FmtSetPicture(ctrl, sPicture)

Sets the picture format of a data field or table window column.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
sPicture	SalString

Returns: SalBoolean.

FmtSetProfile(ctrl, nProfile)

Changes the culture profile for the specified field.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nProfile	SalNumber

Returns: SalBoolean.

FmtStrToField(ctrl, value, bFormat)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
value	SalString
bFormat	SalBoolean

Returns: SalBoolean.

FmtUnmaskInput(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString&

Returns: SalBoolean.

FmtValidateField(ctrl, nValidate)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nValidate	SalNumber

Returns: SalBoolean.

FontGet(ctrl, name, size, nEnhancement)

Parameter	Type	Description
ctrl	Control
name	SalString&
size	SalNumber&
nEnhancement	SalNumber&

Returns: SalBoolean.

FontGetNames(nType, sFonts)

Gets the names of the screen or printer fonts.

Parameter	Type	Description
nType	SalNumber	A constant that specifies whether to get the screen or printer fonts: FONT_GetPrinter FONT_GetScreen
sFonts	SalArray<SalString>	The name of an array of strings that contains the font names returned.

Returns: SalNumber. nNames

FontGetSizes(get, fontName, fontSizes)

Deprecated: Use FontFamilies instead.

Parameter	Type	Description
get	SalNumber
fontName	SalString
fontSizes	SalArray`1&

Returns: SalNumber.

FontSet(ctrl, name, size, nEnhancement)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
name	SalString
size	SalNumber
nEnhancement	SalNumber

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
formUnits	SalNumber
vertical	SalBoolean

Returns: SalNumber.

GetBufferLength(buffer)

Returns the current buffer length of a binary variable.

Parameter	Type	Description
buffer	SalBinary

Returns: SalNumber.

GetBufferLength(str)

Returns the current buffer length of a string.

Parameter	Type	Description
str	SalString

Returns: SalNumber.

GetDataType(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalWindowHandle.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
typeMask	SalNumber

Returns: SalWindowHandle.

GetFocus()

Returns the handle of the window with the focus.

Returns: SalWindowHandle. windowFocus

GetItemName(ctrl, name)

Parameter	Type	Description
ctrl	Control
name	SalString&

Returns: SalBoolean.

GetMaxDataLength(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

GetNextChild(ctrl, typeMask)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
typeMask	SalNumber

Returns: SalWindowHandle.

GetProfileInt(section, entry, defaultValue, fileName)

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

Parameter	Type	Description
section	SalString
entry	SalString
defaultValue	SalNumber
fileName	SalString

Returns: SalNumber.

GetProfileString(section, entry, defaultValue, value, fileName)

Parameter	Type	Description
section	SalString
entry	SalString
defaultValue	SalString
value	SalString&
fileName	SalString

Returns: SalNumber.

GetReportObject(handle)

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

Parameter	Type	Description
handle	IntPtr	The reference handle to the ISalReport object.

Returns: ISalReport.

GetVersion()

Returns the version of the library.

Returns: SalNumber.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalWindowHandle.

GetWindowLabelText(ctrl, text, maxLength)

Parameter	Type	Description
ctrl	Control
text	SalString&
maxLength	SalNumber

Returns: SalNumber.

GetWindowLoc(ctrl, x, y)

Parameter	Type	Description
ctrl	Control
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetWindowSize(ctrl, width, height)

Parameter	Type	Description
ctrl	Control
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetWindowState(ctrl)

Returns a window's current state.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

GetWindowText(ctrl, text, maxLen)

Parameter	Type	Description
ctrl	Control
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

HideWindow(ctrl)

Hides a window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

HideWindowAndLabel(ctrl)

Hides a window and its associated label.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

HStringToNumber(str)

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

Parameter	Type	Description
str	SalString

Returns: SalNumber.

InvalidateWindow(ctrl)

Causes a window to be repainted.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsButtonChecked(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsNull(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsValidDateTime(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsValidDecimal(ctrl, precision, scale)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

IsValidInteger(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsValidNumber(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsWindowEnabled(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

IsWindowVisible(ctrl)

Determines whether a window is currently visible.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

ListAdd(ctrl, text)

Adds a string to a list box or combo box.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
text	SalString	Text of the item to add to the list.

Returns: SalNumber. Index of the added item.

ListClear(ctrl)

Deletes all entries from a list box or combo box.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

ListDelete(ctrl, index)

Deletes a list box or combo box entry.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to remove from the list.

Returns: SalNumber.

ListFiles(ctrl, ctrlPath, pathName, attributes)

Parameter	Type	Description
ctrl	Control
ctrlPath	Control
pathName	SalString&
attributes	SalNumber

Returns: SalBoolean.

ListGetMultiSelect(ctrl, selectedArray)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
selectedArray	SalArray<SalNumber>	Array to receive the list of selected indices.

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

ListInsert(ctrl, index, text)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Position in the list where to insert the text .
text	SalString	Text of the item to insert in the list.

Returns: SalNumber. The index of the added item or Sys.LB_Err (-1) if there is an error.

ListPopulate(ctrl, sql, select)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
sql	SalSqlHandle	A SalSqlHandle to execute the sql command.
select	SalString	SQL command to execute.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
sql	SalSqlHandle	A SalSqlHandle to execute the sql command.
select	SalString	SQL command to execute.
errorHandler	WhenSqlErrorHandler	SQL error handler callback.

Returns: SalBoolean.

ListQueryCount(ctrl)

Returns the number of list box or combo box entries.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber. Number of items in the list.

ListQueryFile(ctrl, fileName)

Parameter	Type	Description
ctrl	Control
fileName	SalString&

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber. Number of selected items.

ListQuerySelection(ctrl)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

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

ListQueryState(ctrl, index)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to query.

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

ListQueryText(ctrl, index, text)

Parameter	Type	Description
ctrl	Control
index	SalNumber
text	SalString&

Returns: SalNumber.

ListQueryTextLength(ctrl, index)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to retrieve the text length for.

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

ListQueryTextX(ctrl, index)

Returns the text of the specified item.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to retrieve the text for.

Returns: SalString. Text of the specified item.

ListSelectString(ctrl, startIndex, text)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
startIndex	SalNumber	Position where to start the search for text .
text	SalString	Text to search for in the list.

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

ListSetMultiSelect(ctrl, index, select)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to select or deselect. Use -1 for all the items in the list.
select	SalBoolean	True to select, or false to deselect the item.

Returns: SalBoolean.

ListSetSelect(ctrl, index)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
index	SalNumber	Index of the item to select. Use -1 for all the items in the list.

Returns: SalBoolean.

LoadApp(name, parameters)

Starts an application.

Parameter	Type	Description
name	SalString
parameters	SalString

Returns: SalBoolean.

LoadAppAndWait(name, mode, retCode)

Parameter	Type	Description
name	SalString
mode	SalNumber
retCode	SalNumber&

Returns: SalBoolean.

Log(fileName, message)

Appends the string to the file.

Parameter	Type	Description
fileName	SalString
message	SalString

Returns: SalBoolean.

LogLine(fileName, message)

Appends the string and a new line to the file.

Parameter	Type	Description
fileName	SalString
message	SalString

Returns: SalBoolean.

LogResource(fileName)

Deprecated: Use Sal.Log(). Logs the available resources to the file.

Parameter	Type	Description
fileName	SalString

Returns: SalBoolean.

MapEnterToTab(bState)

Changes the behavior of the Enter key from executing the default button on a window to moving the focus to the next field.

Parameter	Type	Description
bState	SalBoolean	True or false to enable or disable using the Enter key to tab to the next field.

Returns: SalBoolean. The value of MapEnterToTab.

MessageBeep(sSoundBase64)

Generates a sound on the computer's speaker.

Parameter	Type	Description
sSoundBase64	String	The beep to play in base64 wav format. The default is null to play the built-in beep.

Returns: SalBoolean. Always True.

MessageBox(text, callback)

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

Parameter	Type	Description
text	SalString	The message text.
callback	Action<Int32>	Optional callback handler. When set, the messagebox is not modal.

Returns: SalNumber. One of Sys.IDOK, Sys.IDCANCEL, Sys.IDRETRY, Sys.IDNO, Sys.IDYES, Sys.IDIGNORE, Sys.IDABORT.

MessageBox(text, title, flags, callback)

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

Parameter	Type	Description
text	SalString	The message text.
title	SalString	The message box title.
flags	SalNumber	The message box style. Combine the MB_* options using the OR (|) operator.
callback	Action<Int32>	Optional callback handler. When set, the messagebox is not modal.

Returns: SalNumber. One of Sys.IDOK, Sys.IDCANCEL, Sys.IDRETRY, Sys.IDNO, Sys.IDYES, Sys.IDIGNORE, Sys.IDABORT.

MessageBox(owner, text, title, flags, callback)

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

Parameter	Type	Description
owner	Control	The owner of the message box.
text	SalString	The message text.
title	SalString	The message box title.
flags	SalNumber	The message box style. Combine the MB_* options using the OR (|) operator.
callback	Action<Int32>	Optional callback handler. When set, the messagebox is not modal.

Returns: SalNumber. One of Sys.IDOK, Sys.IDCANCEL, Sys.IDRETRY, Sys.IDNO, Sys.IDYES, Sys.IDIGNORE, Sys.IDABORT.

ModalDialog(dialogType, owner, parameters)

Creates a modal dialog box.

Parameter	Type	Description
dialogType	Type	The dialog to create.
owner	Control	Owner of the dialog.
parameters	Object[]	Optional parameter list.

Returns: SalNumber. The value set when closing the dialog using EndDialog.

ModalDialog(dialogType, owner, callback, parameters)

Creates a modal dialog box and returns the value asynchronously calling the provided callback function.

Parameter	Type	Description
dialogType	Type	The dialog to create.
owner	Control	Owner of the dialog.
callback	Action<Int32>	Callback method, invoked when the dialog is closed.
parameters	Object[]	Optional parameter list.

ModalDialog(dialogName, owner, parameters)

Creates a modal dialog box.

Parameter	Type	Description
dialogName	SalString	Name of the dialog to create.
owner	Control	Owner of the dialog.
parameters	Object[]	Optional parameter list.

Returns: SalNumber.

ModalDialog(dialogName, owner)

Creates a modal dialog box.

Parameter	Type	Description
dialogName	SalString	Name of the dialog to create.
owner	Control	Owner of the dialog.

Returns: SalNumber.

ModalDialogAsync(dialogType, owner, parameters)

Creates a modal dialog box asynchronously.

Parameter	Type	Description
dialogType	Type	The dialog to create.
owner	Control	Owner of the dialog.
parameters	Object[]	Optional parameter list.

Returns: Task<Int32>. The value set when closing the dialog using EndDialog.

ModalDialogAsync(dialogName, owner, parameters)

Creates a modal dialog box asynchronously.

Parameter	Type	Description
dialogName	SalString	Name of the dialog to create.
owner	Control	Owner of the dialog.
parameters	Object[]	Optional parameter list.

Returns: Task<Int32>.

ModalDialogFromStr(dialogName, owner)

Creates a modal dialog box.

Parameter	Type	Description
dialogName	SalString	Name of the dialog to create.
owner	Control	Owner of the dialog.

Returns: SalNumber.

MoveWindow(ctrl, xOffset, yOffset)

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

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
xOffset	SalNumber
yOffset	SalNumber

Returns: SalBoolean.

MTSCreateInstance(oObj)

Parameter	Type	Description
oObj	Object&

Returns: SalBoolean.

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. bOk

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. bOk

MTSGetObjectContext(obj, context)

Deprecated: Not supported.

Parameter	Type	Description
obj	Object
context	SalNumber&

Returns: SalBoolean.

MTSIsCallerInRole(strRole, bInRole)

Parameter	Type	Description
strRole	SalString
bInRole	SalBoolean&

Returns: SalBoolean.

MTSIsInTransaction(bIsInTransaction)

Parameter	Type	Description
bIsInTransaction	SalBoolean&

Returns: SalBoolean.

MTSIsSecurityEnabled(bIsSecurityEnabled)

Parameter	Type	Description
bIsSecurityEnabled	SalBoolean&

Returns: SalBoolean.

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. bOk

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. bOk

NavAddGroup(control, paneIndex, groupIndex, groupTitle, height)

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

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane to which you want to add a group.
groupIndex	SalNumber	Zero-based index that the new group will occupy.
groupTitle	SalString	The title of the new group.
height	SalNumber	The height of the new group in form units.

Returns: SalBoolean.

NavAddPane(control, paneIndex, name, image)

Inserts a pane into the navigation bar control.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	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.
name	SalString	Name of the new pane (object title)
image	SalString	File name of the image to display for the new pane.

Returns: SalBoolean.

NavAssociateChild(control, paneIndex, groupIndex, child)

Associates a control to a pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane.
groupIndex	SalNumber	Zero-based index of the group. If the pane has no groups, use zero.
child	Control	the control you're associating to the pane.

Returns: SalBoolean.

NavDisassociateChild(control, paneIndex, child)

Disassociates a control from a pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane
child	Control	The control you're disassociating

Returns: SalBoolean.

NavEnablePane(control, paneIndex, enable)

Enables or disables a pane on the navigation bar.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Index for the pane to enable (start at 0).
enable	SalBoolean	Set TRUE to enable pane, FALSE to disable.

Returns: SalBoolean.

NavExpandGroup(control, paneIndex, groupIndex, expand)

Expands or collapses a group.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane
groupIndex	SalNumber	Zero-based index of the group
expand	SalBoolean	Set to TRUE to expand, FALSE to collapse

Returns: SalBoolean.

NavGetActivePane(control)

Returns the index of the currently selected pane.

Parameter	Type	Description
control	Control	The NavBar control.

Returns: SalNumber. The zero-based index of the currently selected pane.

NavGetPaneIcon(control, paneIndex, image)

Parameter	Type	Description
control	Control
paneIndex	SalNumber
image	SalString&

Returns: SalBoolean.

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.

Parameter	Type	Description
control	Control	The NavBar control.
name	SalString	The name of the pane (object title)

Returns: SalNumber. the zero-based index of the pane. If the pane is not found, index is -1.

NavGetPaneTitle(control, paneIndex, title)

Parameter	Type	Description
control	Control
paneIndex	SalNumber
title	SalString&

Returns: SalBoolean.

NavGetPaneTitle(control, paneIndex)

Returns the title of a pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Index for the pane whose title you want to get (start at 0)

Returns: SalString.

NavGroupIsExpanded(control, paneIndex, groupIndex)

Retrieves the group status. The function returns true if the group is expanded; false if collapsed.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane
groupIndex	SalNumber	Zero-based index of the group

Returns: SalBoolean.

NavLoadState(control, xml)

Restore the settings of a navigation bar from an XML string.

Parameter	Type	Description
control	Control	The NavBar control.
xml	SalString

Returns: SalBoolean.

NavPaneIsEnabled(control, paneIndex)

Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Index of pane (start at 0).

Returns: SalBoolean.

NavRemoveGroup(control, paneIndex, groupIndex)

Removes a group from the navigation bar control.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane to be removed.
groupIndex	SalNumber	Zero-based index of the group to remove.

Returns: SalBoolean.

NavRemovePane(control, paneIndex)

Removes a pane from the navigation bar control.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Zero-based index of the pane to be removed.

Returns: SalBoolean.

NavSaveState(control, xml)

Parameter	Type	Description
control	Control
xml	SalString&

Returns: SalBoolean.

NavSetActivePane(control, paneIndex)

Activates the indicated pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	The zero-based index of the pane to activate.

Returns: SalBoolean.

NavSetPaneIcon(control, paneIndex, image)

Sets the title of a pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Index for the pane.
image	SalString	File name of the image to display for the pane.

Returns: SalBoolean.

NavSetPaneTitle(control, paneIndex, title)

Sets the title of a pane.

Parameter	Type	Description
control	Control	The NavBar control.
paneIndex	SalNumber	Index for the pane whose title you want to get (start at 0).
title	SalString	The new title for the pane.

Returns: SalBoolean.

NumberAbs(num)

Computes the absolute num.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberArcCos(num)

Computes the arc cosine of a num in the range 0 to 1.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberArcSin(num)

Computes a num's arc sine.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberArcTan(num)

Computes a num's arc tangent.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

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 num.

Parameter	Type	Description
numY	SalNumber
numX	SalNumber

Returns: SalNumber.

NumberCos(angle)

Computes an angle's cosine.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberCosH(angle)

Computes an angle's hyperbolic cosine.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberExponent(num)

Computes a num's exponential function.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberHigh(num)

Returns a number's high-order word num (most significant 16 bits).

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberHypot(x, y)

Computes the length of the hypotenuse of a right triangle, given the lengths of the other two sides.

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalNumber.

NumberLog(num)

Computes a number's natural logarithm.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberLogBase10(num)

Computes a number's base -10 logarithm.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberLow(num)

Returns a number's low-order word num (least significant 16 bits).

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberMax(num1, num2)

Returns the greater of two numbers.

Parameter	Type	Description
num1	SalNumber
num2	SalNumber

Returns: SalNumber.

NumberMin(num1, num2)

Returns the lesser of two numbers.

Parameter	Type	Description
num1	SalNumber
num2	SalNumber

Returns: SalNumber.

NumberMod(num, mod)

Returns a number's modulo.

Parameter	Type	Description
num	SalNumber
mod	SalNumber

Returns: SalNumber.

NumberPi(num)

Multiples a number by Pi.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberPower(num, exponent)

Computes x raised to the power of y.

Parameter	Type	Description
num	SalNumber
exponent	SalNumber

Returns: SalNumber.

NumberRandInit(seed)

Sets the starting point for generating a series of pseudo-random numbers using SalNumberRandom.

Parameter	Type	Description
seed	SalNumber

Returns: SalBoolean.

NumberRandom()

Generates a pseudo-random number. The numbers generated by this function are integers in the range 0 to 32767.

Returns: SalNumber.

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.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberSin(angle)

Computes an angle's sine.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberSinH(angle)

Computes an angle's hyperbolic sine.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberSqrt(num)

Computes a number's square root.

Parameter	Type	Description
num	SalNumber

Returns: SalNumber.

NumberTan(angle)

Computes an angle's tangent.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberTanH(angle)

Computes an angle's hyperbolic tangent.

Parameter	Type	Description
angle	SalNumber

Returns: SalNumber.

NumberToChar(num)

Converts a decimal num to a UNICODE character.

Parameter	Type	Description
num	SalNumber

Returns: SalString.

NumberToHString(handle)

Converts a string handle to the corresponding string instance.

Parameter	Type	Description
handle	SalNumber

Returns: SalString.

NumberToStr(num, nDecimalPlaces, str)

Parameter	Type	Description
num	SalNumber
nDecimalPlaces	SalNumber
str	SalString&

Returns: SalNumber.

NumberToStrX(num, nDecimalPlaces)

Converts a number to a string.

Parameter	Type	Description
num	SalNumber
nDecimalPlaces	SalNumber

Returns: SalString.

NumberToWindowHandle(num)

Converts a number to a window handle.

Parameter	Type	Description
num	SalNumber

Returns: SalWindowHandle.

NumberTruncate(num, precision, scale)

Truncates a number.

Parameter	Type	Description
num	SalNumber
precision	SalNumber
scale	SalNumber

Returns: SalNumber.

ObjCreateFromString(className)

Creates an instance of the class.

Parameter	Type	Description
className	SalString	Class name

Returns: SalFunctionalClass.

ObjGetType(userObject)

This function returns the name of the class for the object.

Parameter	Type	Description
userObject	SalFunctionalClass

Returns: SalString.

ObjIsDerived(userObject, className)

Returns true if the object is derived from the class specified.

Parameter	Type	Description
userObject	SalFunctionalClass
className	SalString

Returns: SalBoolean.

ObjIsNull(userObject)

This function checks to see if the variable of a functional, coclass, or interface class is null.

Parameter	Type	Description
userObject	SalFunctionalClass

Returns: SalBoolean.

ObjIsValidClasname(className)

Determine whether className holds a valid user-defined class name.

Parameter	Type	Description
className	SalString

Returns: SalBoolean.

ParentWindow(ctrl)

Returns the handle of an object's parent window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalWindowHandle.

Pause(milliseconds)

Pauses the execution for the specified number of milliseconds.

Parameter	Type	Description
milliseconds	SalNumber

Returns: Boolean.

PicClear(ctrl)

Deletes the contents of a picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

PicGetDescription(ctrl, description, maxLen)

Parameter	Type	Description
ctrl	Control
description	SalString&
maxLen	SalNumber

Returns: SalNumber.

PicGetImage(ctrl, buffer, type)

Parameter	Type	Description
ctrl	Control
buffer	SalString&
type	SalNumber&

Returns: SalNumber.

PicGetImage(ctrl, buffer, type)

Parameter	Type	Description
ctrl	Control
buffer	SalBinary&
type	SalNumber&

Returns: SalNumber.

PicGetString(ctrl, format, buffer)

Parameter	Type	Description
ctrl	Control
format	SalNumber
buffer	SalString&

Returns: SalNumber.

PicGetString(ctrl, format, buffer)

Parameter	Type	Description
ctrl	Control
format	SalNumber
buffer	SalBinary&

Returns: SalNumber.

PicSet(ctrl, resourceType, format)

Inserts a resource into a picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
resourceType	SalResource
format	SalNumber

Returns: SalBoolean.

PicSetFile(ctrl, fileName)

Inserts a file's contents into a picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
fileName	SalString

Returns: SalBoolean.

PicSetFit(ctrl, fit, scaleWidth, scaleHeight)

Deprecated: PicSetFit(ctrl, fit, scaleWidth, scaleHeight) is deprecated, use PicSetFit(ctrl, fit) Sets the fit for a picture.

Parameter	Type	Description
ctrl	Control	A SalPicture control.
fit	SalNumber	One of PIC_FitBestFit, PIC_FitScale, PIC_FitSizeToFit.
scaleWidth	SalNumber	Not supported.
scaleHeight	SalNumber	Not supported.

Returns: SalBoolean.

PicSetFit(ctrl, fit)

Sets the fit for a picture.

Parameter	Type	Description
ctrl	Control	A SalPicture control.
fit	SalNumber	One of PIC_FitBestFit, PIC_FitScale, PIC_FitSizeToFit.

Returns: SalBoolean.

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.

Parameter	Type	Description
ctrl	Control	An image control.
type	SalNumber	One of PIC_FormatIcon or PIC_FormatBitmap.
handle	SalNumber	HICON or HBITMAp handle of the image.

Returns: SalBoolean.

PicSetImage(ctrl, buffer, type)

Inserts the contents of a picture to an image without the image header.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
buffer	SalString
type	SalNumber

Returns: SalBoolean.

PicSetString(ctrl, format, buffer)

Inserts the contents of a string into a picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
format	SalNumber
buffer	SalString

Returns: SalBoolean.

PicSetString(ctrl, format, buffer)

Inserts the contents of a binary buffer into a picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
format	SalNumber
buffer	SalBinary

Returns: SalBoolean.

PixelsToFormUnits(ctrl, nNumPixels, 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.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nNumPixels	SalNumber
vertical	SalBoolean

Returns: SalNumber.

PostMsg(ctrl, nMsg, wParam, lParam)

Posts the specified message to a window by adding nMsg to windowReceiver's message queue.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nMsg	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

PrtExtractRect(lParam, left, top, right, bottom)

Parameter	Type	Description
lParam	SalNumber
left	SalNumber&
top	SalNumber&
right	SalNumber&
bottom	SalNumber&

Returns: SalBoolean.

PrtGetDefault(sDevice, sDriver, sPort)

Parameter	Type	Description
sDevice	SalString&
sDriver	SalString&
sPort	SalString&

Returns: SalBoolean.

PrtGetList(refresh)

Returns the list of installed printers.

Parameter	Type	Description
refresh	SalBoolean	True to rebuild the list of printers.

Returns: String[].

PrtGetParmNum(nParm, nValue)

Parameter	Type	Description
nParm	SalNumber
nValue	SalNumber&

Returns: SalBoolean.

PrtPreviewForm(ctrl)

Prints a form window, table window, or dialog box, including its contents and row header flags.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean. bOk

PrtPrintForm(ctrl)

Prints a form window, table window, or dialog box, including its contents and row header flags.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean. bOk

PrtSetDefault(sDevice, sDriver, sPort)

Sets the default device (printer), driver, and port.

Parameter	Type	Description
sDevice	SalString	The default device.
sDriver	SalString	Not used.
sPort	SalString	Not used.

Returns: SalBoolean. bOk

PrtSetParmDefaults()

Resets print parameters back to their default values.

Returns: SalBoolean. bOk

PrtSetParmNum(nParm, nValue)

Sets the value of a print parameter. The print parameters are a set of global variables which are initialized to default values and can be set using SalPrtSetParmNum, retrieved using SalPrtGetParmNum or reinitialized using SalPrtSetParmDefaults.

Parameter	Type	Description
nParm	SalNumber	A constant that represents the parameter to set; one of the PRT_* constants.
nValue	SalNumber	The parameter value.

Returns: SalBoolean. bOk

PrtSetup(sDevice, sDriver, sPort, bActiveOnly)

Parameter	Type	Description
sDevice	SalString&
sDriver	SalString&
sPort	SalString&
bActiveOnly	SalBoolean

Returns: SalBoolean.

QueryFieldEdit(ctrl)

Returns the setting of the Field Edit Flag for a data field, multiline field, combo box, table window's context row cell, or picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

Quit()

Exits an application.

Returns: SalBoolean.

ReportClose(reportWindow)

Closes a report window.

Parameter	Type	Description
reportWindow	SalWindowHandle	Reference to the report window to close.

Returns: SalBoolean. True if successful.

ReportCmd(reportWindow, command)

Sends a command to an open report window.

Parameter	Type	Description
reportWindow	SalWindowHandle	Reference to the report window to send the command to.
command	SalNumber	The identifier of the command to send to the report window, one of: RPT_CmdFirstPage, RPT_CmdGoToPageRPT_CmdLastPageRPT_CmdNextPage, RPT_CmdPrevPage, RPT_CmdPrint, RPT_CmdPrinterSetup, RPT_CmdSizeActual, RPT_CmdSizeFit. Not all commands are implemented by all reporting engines/

Returns: SalBoolean.

ReportCreate(fileName, variableNames, inputs, defaultReport, error)

Parameter	Type	Description
fileName	SalString
variableNames	SalString
inputs	SalString
defaultReport	SalBoolean
error	SalNumber&

Returns: SalBoolean.

ReportCreate(fileName, variableNames, inputs, defaultReport, error, template)

Parameter	Type	Description
fileName	SalString
variableNames	SalString
inputs	SalString
defaultReport	SalBoolean
error	SalNumber&
template	SalString

Returns: SalBoolean.

ReportDlgOptions(reportWindow, caption, line1, line2, docName)

Sets the options for the report printing dialog box.

Parameter	Type	Description
reportWindow	SalWindowHandle	Reference to the report window to configure.
caption	SalString	Title of the progress dialog.
line1	SalString	Line 1 below the title of the progress dialog.
line2	SalString	Line 2 below the title of the progress dialog.
docName	SalString	The of the document being printed to display on the progress dialog.

Returns: SalBoolean. True if successful.

ReportGetDateTimeVar(reportWindow, variableName, value)

Parameter	Type	Description
reportWindow	SalWindowHandle
variableName	SalString
value	SalDateTime&

Returns: SalBoolean.

ReportGetNumberVar(reportWindow, variableName, value)

Parameter	Type	Description
reportWindow	SalWindowHandle
variableName	SalString
value	SalNumber&

Returns: SalBoolean.

ReportGetObjectVar(reportWindow, variableName, value)

Parameter	Type	Description
reportWindow	SalWindowHandle
variableName	SalString
value	SalString&

Returns: SalBoolean.

ReportGetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)

Parameter	Type	Description
windowReport	SalWindowHandle
printerName	SalString&
orientation	SalNumber&
paperType	SalNumber&
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

ReportGetStringVar(reportWindow, variableName, value)

Parameter	Type	Description
reportWindow	SalWindowHandle
variableName	SalString
value	SalString&

Returns: SalBoolean.

ReportOpen(owner, template, variableNames, inputs, flags)

Parameter	Type	Description
owner	Control
template	SalString
variableNames	SalString
inputs	SalString
flags	SalNumber&

Returns: SalWindowHandle.

ReportPrint(owner, template, variableNames, inputs, copies, options, firstPage, lastPage, error)

Parameter	Type	Description
owner	Control
template	SalString
variableNames	SalString
inputs	SalString
copies	SalNumber
options	SalNumber
firstPage	SalNumber
lastPage	SalNumber
error	SalNumber&

Returns: SalWindowHandle.

ReportPrintToFile(owner, template, destFile, variableNames, inputs, copies, options, firstPage, lastPage, rtfFormat, error)

Parameter	Type	Description
owner	Control
template	SalString
destFile	SalString
variableNames	SalString
inputs	SalString
copies	SalNumber
options	SalNumber
firstPage	SalNumber
lastPage	SalNumber
rtfFormat	SalBoolean
error	SalNumber&

Returns: SalWindowHandle.

ReportPrintToFile(owner, template, destFile, variableNames, inputs, options, firstPage, lastPage, error)

Parameter	Type	Description
owner	Control
template	SalString
destFile	SalString
variableNames	SalString
inputs	SalString
options	SalNumber
firstPage	SalNumber
lastPage	SalNumber
error	SalNumber&

Returns: SalWindowHandle.

ReportSetDateTimeVar(windowReport, variableName, value)

Sets the value of a date/time report variable.

Parameter	Type	Description
windowReport	SalWindowHandle
variableName	SalString
value	SalDateTime

Returns: SalBoolean.

ReportSetNumberVar(windowReport, variableName, value)

Sets the value of a numeric report variable.

Parameter	Type	Description
windowReport	IntPtr
variableName	SalString
value	SalNumber

Returns: SalBoolean.

ReportSetObjectVar(windowReport, variableName, value)

Sets the value of an object report variable.

Parameter	Type	Description
windowReport	IntPtr	The window handle of the report window.
variableName	SalString	The name of the variable whose value you want to set.
value	SalString	The value of variableName.

Returns: SalBoolean. bOk

ReportSetPrinterSettings(windowReport, printerName, orientation, paperType, width, height)

Sets the printer properties at runtime. This function should be called wile processing the SAM_ReportStart event.

Parameter	Type	Description
windowReport	SalWindowHandle
printerName	SalString	Friendly name of the printer. Pass STRING_Null or an empty string if you do not want to switch the printer.
orientation	SalNumber	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.
paperType	SalNumber	Paper type. Use one of the RPT_Paper* constants or the PaperKind enum.
width	SalNumber	Paper width in milli-inches. This value is ignored for all paper types except for RPT_PaperCustom.
height	SalNumber	Paper height in milli-inches. This value is ignored for all paper types except for RPT_PaperCustom.

Returns: SalBoolean.

ReportSetStringVar(windowReport, variableName, value)

Sets the value of a string report variable.

Parameter	Type	Description
windowReport	IntPtr
variableName	SalString
value	SalString

Returns: SalBoolean.

ReportTableCreate(fileName, table, error)

Parameter	Type	Description
fileName	SalString
table	Control
error	SalNumber&

Returns: SalBoolean.

ReportTableCreate(fileName, table, error, template)

Parameter	Type	Description
fileName	SalString
table	Control
error	SalNumber&
template	SalString

Returns: SalBoolean.

ReportTablePrint(table, sTemplate, nParamArray, nError)

Parameter	Type	Description
table	Control
sTemplate	SalString
nParamArray	SalArray<SalNumber>
nError	SalNumber&

Returns: SalWindowHandle.

ReportTableView(table, parent, sTemplate, nError)

Parameter	Type	Description
table	Control
parent	Control
sTemplate	SalString
nError	SalNumber&

Returns: SalWindowHandle.

ReportView(owner, parent, template, variableNames, inputs, flags)

Parameter	Type	Description
owner	Control
parent	Control
template	SalString
variableNames	SalString
inputs	SalString
flags	SalNumber&

Returns: SalWindowHandle.

ResolveType(asm, typeName)

Finds the type in any loaded assembly. The first specified assembly argument has the precedence.

Parameter	Type	Description
asm	Assembly
typeName	String

Returns: Type.

ScrollGetPos(ctrl, nPos)

Parameter	Type	Description
ctrl	Control
nPos	SalNumber&

Returns: SalBoolean.

ScrollGetRange(ctrl, min, max, line, page)

Parameter	Type	Description
ctrl	Control
min	SalNumber&
max	SalNumber&
line	SalNumber&
page	SalNumber&

Returns: SalBoolean.

ScrollSetPos(ctrl, nPos)

Sets the scrollbar's value.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nPos	SalNumber

Returns: SalBoolean.

ScrollSetRange(ctrl, min, max, line, page)

Sets a scroll bar's range, line increment, and page increment.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
min	SalNumber
max	SalNumber
line	SalNumber
page	SalNumber

Returns: SalBoolean.

SendBroadcastMsg(nMsg, wParam, lParam)

Sends a message to all top-level windows in the system, including disabled or invisible unowned windows, overlapped windows, and pop-up windows; but the message is not sent to child windows.

Parameter	Type	Description
nMsg	SalNumber	Message code to send.
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

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.

Parameter	Type	Description
message	SalNumber	Message code to send.
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalNumber. nMsgReturn

SendClassMessageNamed(type, nMsg, 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. Use this function instead of SalSendClassMessage with a class that is the result of multiple inheritance. It lets you specify which base class message action you want to execute.

Parameter	Type	Description
type	Type	The ancestor's class name.
nMsg	SalNumber	Message code to send.
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalNumber. nMsgReturn

SendMsg(ctrl, nMsg, wParam, lParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nMsg	SalNumber	Message code to send.
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalNumber.

SendMsgToChildren(ctrl, nMsg, wParam, lParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
nMsg	SalNumber	Message code to send.
wParam	SalNumber	First argument value to send with the action message.
lParam	SalNumber	second argument value to send with the action message.

Returns: SalBoolean.

SendValidateMsg()

Sends a SAM_Validate message to the object with the focus data field, multiline field, or table window column if it was edited and sets the wParam and lParam message variables to zero (0).

Returns: SalNumber.

SetBufferLength(buffer, length)

Parameter	Type	Description
buffer	SalBinary&
length	SalNumber

Returns: SalBoolean.

SetBufferLength(str, length)

Parameter	Type	Description
str	SalString&
length	SalNumber

Returns: SalBoolean.

SetDefButton(ctrl)

Sets the default push button of a form window or dialog box.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

SetErrorInfo(code, desc, fileName, context)

Sets COM error information.

Parameter	Type	Description
code	SalNumber
desc	SalString
fileName	SalString
context	SalNumber

Returns: SalBoolean.

SetFieldEdit(ctrl, set)

Sets or clears the field edit flag for an editable data field, combo box, multiline text field, table window column, or picture.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
set	SalBoolean

Returns: SalBoolean.

SetFocus(ctrl)

Sets the focus to a specified window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalWindowHandle.

SetMaxDataLength(ctrl, length)

Sets a limit on the number of characters that a user can enter into a data field, multiline text field, or table window column.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
length	SalNumber

Returns: SalBoolean.

SetProfileString(section, entry, value, fileName)

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

Parameter	Type	Description
section	SalString
entry	SalString
value	SalString
fileName	SalString

Returns: SalBoolean.

SetWindowLabelText(ctrl, text)

Sets the text of the label associated to a control. To be associated with a specific window, the background text (label control) must immediately precede the window in the tab index sequence. Important: The label control does not require a mnemonic for the function to operate.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
text	SalString

Returns: SalBoolean.

SetWindowLoc(ctrl, x, y)

Moves a window to a new position (x, y) on the X and Y axes.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetWindowSize(ctrl, width, height)

Resizes a window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetWindowText(ctrl, text)

Sets the text of a window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
text	SalString

Returns: SalBoolean.

ShowWindow(ctrl)

Makes a window visible.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

ShowWindowAndLabel(ctrl)

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

StartTrace(outputType, traceFile, clearExisting)

Begins tracing.

Parameter	Type	Description
outputType	SalNumber
traceFile	SalString
clearExisting	SalBoolean

Returns: SalBoolean.

StaticFirst(form)

Returns a "handle" to the first static on a window

Parameter	Type	Description
form	Control

Returns: SalNumber.

StaticGetLabel(ctrl)

Gets the static "handle" if the label for a specified control

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalNumber.

StaticGetLoc(form, handle, x, y)

Parameter	Type	Description
form	Control
handle	SalNumber
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

StaticGetSize(form, handle, width, height)

Parameter	Type	Description
form	Control
handle	SalNumber
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

StaticHide(form, handle)

Hides a static

Parameter	Type	Description
form	Control
handle	SalNumber

Returns: SalBoolean.

StaticIsVisible(form, handle)

Determines whether a static is visible.

Parameter	Type	Description
form	Control
handle	SalNumber

Returns: SalBoolean.

StaticNext(form, handle)

Returns a "handle" to the last static on a window

Parameter	Type	Description
form	Control
handle	SalNumber

Returns: SalNumber.

StaticSetLoc(form, handle, x, y)

Sets the location coordinates of a static

Parameter	Type	Description
form	Control
handle	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

StaticSetSize(form, handle, width, height)

Sets the size of a static

Parameter	Type	Description
form	Control
handle	SalNumber
width	SalNumber
height	SalNumber

Returns: SalBoolean.

StaticShow(form, handle)

Shows a static

Parameter	Type	Description
form	Control
handle	SalNumber

Returns: SalBoolean.

StatusGetText(ctrl, text, maxLen)

Parameter	Type	Description
ctrl	Control
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

StatusSetText(ctrl, text)

Displays specified text in the status bar of a top-level or MDI window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
text	SalString

Returns: SalBoolean.

StatusSetVisible(ctrl, show)

Shows or hides the status bar on a top-level or MDI window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
show	SalBoolean

Returns: SalBoolean.

StrCompress(str)

Parameter	Type	Description
str	SalString&

Returns: SalBoolean.

StrFirstChar(str, charCode)

Parameter	Type	Description
str	SalString&
charCode	SalNumber&

Returns: SalBoolean.

StrGetBufferLength(str)

Returns the current buffer length of a string.

Parameter	Type	Description
str	SalString

Returns: SalNumber.

StrIsValidCurrency(money, precision, scale)

Verifies that a string represents a valid currency value.

Parameter	Type	Description
money	SalString
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

StrIsValidDateTime(str)

Verifies that string represents a valid date/time value.

Parameter	Type	Description
str	SalString

Returns: SalBoolean.

StrIsValidDecimal(str, precision, scale)

Verifies that an entire character string represents a valid decimal value.

Parameter	Type	Description
str	SalString
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

StrIsValidIdentifierName(str)

Returns TRUE if the string is a valid identifier.

Parameter	Type	Description
str	SalString

Returns: SalBoolean.

StrIsValidNumber(str)

Verifies that a string represents a valid number value.

Parameter	Type	Description
str	SalString

Returns: SalBoolean.

StrLeft(source, length, target)

Parameter	Type	Description
source	SalString
length	SalNumber
target	SalString&

Returns: SalNumber.

StrLeftX(source, length)

Returns a substring of a specified length starting at position zero.

Parameter	Type	Description
source	SalString
length	SalNumber

Returns: SalString.

StrLength(str)

Returns a string's length.

Parameter	Type	Description
str	SalString

Returns: SalNumber.

StrLop(str)

Parameter	Type	Description
str	SalString&

Returns: SalNumber.

StrLower(source, target)

Parameter	Type	Description
source	SalString
target	SalString&

Returns: SalNumber.

StrLowerX(source)

Converts a string to lowercase.

Parameter	Type	Description
source	SalString

Returns: SalString.

StrMid(source, startPos, length, target)

Parameter	Type	Description
source	SalString
startPos	SalNumber
length	SalNumber
target	SalString&

Returns: SalNumber.

StrMidX(source, startPos, length)

Returns a substring, starting at a specified position and containing a specified number of characters.

Parameter	Type	Description
source	SalString
startPos	SalNumber
length	SalNumber

Returns: SalString.

StrProper(source, target)

Parameter	Type	Description
source	SalString
target	SalString&

Returns: SalNumber.

StrProperX(source)

Converts a string to a proper name.

Parameter	Type	Description
source	SalString

Returns: SalString.

StrRepeat(source, times, target)

Parameter	Type	Description
source	SalString
times	SalNumber
target	SalString&

Returns: SalNumber.

StrRepeatX(source, times)

Concatenates a string with itself a specified number of times.

Parameter	Type	Description
source	SalString
times	SalNumber

Returns: SalString.

StrReplace(source, startPos, length, replace, target)

Parameter	Type	Description
source	SalString
startPos	SalNumber
length	SalNumber
replace	SalString
target	SalString&

Returns: SalNumber.

StrReplaceX(source, startPos, length, sReplace)

Replaces characters in one string with characters from another string.

Parameter	Type	Description
source	SalString
startPos	SalNumber
length	SalNumber
sReplace	SalString

Returns: SalString.

StrRight(source, length, target)

Parameter	Type	Description
source	SalString
length	SalNumber
target	SalString&

Returns: SalNumber.

StrRightX(source, length)

Returns a string of specified length, starting with the last character in the string.

Parameter	Type	Description
source	SalString
length	SalNumber

Returns: SalString.

StrScan(str1, str2)

Returns the offset of a specified substring.

Parameter	Type	Description
str1	SalString
str2	SalString

Returns: SalNumber.

StrSetBufferLength(str, length)

Parameter	Type	Description
str	SalString&
length	SalNumber

Returns: SalBoolean.

StrToDate(str)

Converts a string to a date/time value.

Parameter	Type	Description
str	SalString

Returns: SalDateTime.

StrTokenize(source, startDel, endDel, target)

Parses a string into substrings (tokens) based on specified start and end delimiters.

Parameter	Type	Description
source	SalString
startDel	SalString
endDel	SalString
target	SalArray<SalString>

Returns: SalNumber.

StrToNumber(str)

Converts a string to a number.

Parameter	Type	Description
str	SalString

Returns: SalNumber.

StrTrim(source, target)

Parameter	Type	Description
source	SalString
target	SalString&

Returns: SalNumber.

StrTrimX(source)

Strips leading and trailing blanks and compresses multiple spaces and tabs within a string to single spaces.

Parameter	Type	Description
source	SalString

Returns: SalString.

StrUncompress(str)

Parameter	Type	Description
str	SalString&

Returns: SalBoolean.

StrUpper(source, target)

Parameter	Type	Description
source	SalString
target	SalString&

Returns: SalNumber.

StrUpperX(source)

Converts a string to uppercase.

Parameter	Type	Description
source	SalString

Returns: SalString.

TabAddPage(control, pageIndex, pageName)

Adds a tab page at a valid index position.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean.

TabAddPageEx(control, pageIndex, pageName, imageFile, tooltip)

Adds a tab page at a valid index position. You can include an image and a tooltip.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
pageName	SalString
imageFile	SalString
tooltip	SalString

Returns: SalBoolean.

TabAssociateChild(control, pageIndex, child)

Associates a child to a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
child	Control

Returns: SalBoolean.

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.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
form	Control

Returns: SalBoolean.

TabDetachWindow(control, pageIndex)

Detaches a child window from the specified tab control.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalWindowHandle.

TabDisablePage(control, pageIndex)

Disables a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

TabDisassociateChild(control, pageIndex, child)

Disassociates a child with a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
child	Control

Returns: SalBoolean.

TabEnablePage(control, pageIndex)

Enables a tab page

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

TabGetActivePage(control)

Gets the current active tab page.

Parameter	Type	Description
control	Control

Returns: SalNumber.

TabGetPageIndex(control, pageName)

Gets the tab page index as specified by the tab name.

Parameter	Type	Description
control	Control
pageName	SalString

Returns: SalNumber.

TabGetPageName(control, pageIndex)

ets the name of the tab page (not the title that appears on the tab page at runtime).

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalString.

TabGetPageTitle(control, pageIndex)

Gets the tab page title as specified by the tab index.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalString.

TabGetPageWindow(control, pageIndex)

Gets the window handle of the specified tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalWindowHandle.

TabGetTooltip(control, pageIndex, tooltip, maxLength)

Parameter	Type	Description
control	Control
pageIndex	SalNumber
tooltip	SalString&
maxLength	SalNumber

Returns: SalNumber.

TabHidePage(control, pageIndex)

Hides a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

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 SalTabSetActivePage.

Parameter	Type	Description
control	Control

Returns: SalBoolean.

TabPageCount(control)

Returns the number of tab pages.

Parameter	Type	Description
control	Control

Returns: SalNumber.

TabRemovePage(control, pageIndex)

Removes a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

TabRenamePage(control, pageIndex, pageName)

Renames a tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean.

TabSetActivePage(control, pageIndex)

Activates a tab specified by a particular tab index.

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

TabSetPageTitle(control, pageIndex, pageTitle)

Sets the title of the specified tab page.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
pageTitle	SalString

Returns: SalBoolean.

TabSetTooltip(control, pageIndex, tooltip)

Sets the tooltip text on the specified tab page. Tooltip text appears only on tab selector, not on a tab container window.

Parameter	Type	Description
control	Control
pageIndex	SalNumber
tooltip	SalString

Returns: SalBoolean.

TabShowPage(control, pageIndex)

Shows a tab page

Parameter	Type	Description
control	Control
pageIndex	SalNumber

Returns: SalBoolean.

TabShowStrip(control)

Shows the tab page selector inside the specified tab control.

Parameter	Type	Description
control	Control

Returns: SalBoolean.

TabUpdate(control)

Updates the Tab bar after a SalTabAssociateChild or SalTabDisassociateChild is called.

Parameter	Type	Description
control	Control

Returns: SalBoolean.

TBarSetVisible(ctrl, show)

Shows or hides the tool bar on a top-level or MDI window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
show	SalBoolean

Returns: SalBoolean.

TblAnyRows(table, flagsOn, flagsOff)

Determines whether any rows in the specified table window match certain flags.

Parameter	Type	Description
table	Control
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

TblClearSelection(table)

Deselects all rows of a table window.

Parameter	Type	Description
table	Control

Returns: SalBoolean.

TblColumnAverage(table, columnId, flagsOn, flagsOff)

Computes the average of all column values or only specified column values in a table window.

Parameter	Type	Description
table	Control
columnId	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber.

TblColumnSum(table, columnId, flagsOn, flagsOff)

Computes the sum of all column values or only specified column values in a table window.

Parameter	Type	Description
table	Control
columnId	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber.

TblCopyRows(table, flagsOn, flagsOff)

Copies the contents of the specified table window rows to the Clipboard in text format.

Parameter	Type	Description
table	Control
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

TblCreateColumn(table, columnPos, displayWidth, maxChars, title)

Creates a table window column of string data type at runtime.

Parameter	Type	Description
table	Control
columnPos	SalNumber
displayWidth	SalNumber
maxChars	SalNumber
title	SalString

Returns: SalNumber.

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

Parameter	Type	Description
table	Control
columnPos	SalNumber
displayWidth	SalNumber
title	SalString
maxChars	SalNumber
dataType	SalNumber

Returns: SalNumber.

TblDefineCheckBoxColumn(column, flags, checkedValue, uncheckedValue)

Define a column as a check box.

Parameter	Type	Description
column	Control
flags	SalNumber
checkedValue	SalString
uncheckedValue	SalString

Returns: SalBoolean.

TblDefineDropDownListColumn(column, flags, lines)

Define a column as a drop down list.

Parameter	Type	Description
column	Control
flags	SalNumber
lines	SalNumber

Returns: SalBoolean.

TblDefinePopupEditColumn(column, flags, lines)

Define a column as a popup edit window.

Parameter	Type	Description
column	Control
flags	SalNumber
lines	SalNumber

Returns: SalBoolean.

TblDefineRowHeader(table, title, width, flags, column)

Defines the appearance and behavior of a table window's row header.

Parameter	Type	Description
table	Control	The table window or grid.
title	SalString	The title of the row header column.
width	SalNumber	The width of the row header in pixels.
flags	SalNumber	The row header attributes. You can combine these flags using the OR (|) operator.
column	Control	The column that the row header mirrors.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TblDefineSplitWindow(table, rowsLowerHalf, dragAdjust)

Splits a table window horizontally.

Parameter	Type	Description
table	Control
rowsLowerHalf	SalNumber
dragAdjust	SalBoolean

Returns: SalBoolean.

TblDeleteRow(table, nRow, nFlag)

Deletes a row from a table window but not from the database.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
nRow	SalNumber
nFlag	SalNumber

Returns: SalBoolean.

TblDeleteSelected(table, sql)

Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle

Returns: SalBoolean.

TblDeleteSelected(table, sql, errorHandler)

Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

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.

Parameter	Type	Description
table	Control	Target control on which to execute the call.

Returns: SalBoolean.

TblDoDeletes(table, sql, flagsOn)

Applies a SQL DELETE statement to all table window rows that have flagsOn flags.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
flagsOn	SalNumber

Returns: SalBoolean.

TblDoDeletes(table, sql, flagsOn, errorHandler)

Applies a SQL DELETE statement to all table window rows that have flagsOn flags.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
flagsOn	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

TblDoInserts(table, sql, clearFlags)

Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean.

TblDoInserts(table, sql, clearFlags, errorHandler)

Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

TblDoUpdates(table, sql, clearFlags, errorHandler)

Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.

Parameter	Type	Description
table	Control
sql	SalSqlHandle
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

TblDoUpdates(table, sql, clearFlags)

Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
sql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean.

TblFetchRow(table, nRow)

Sends a SAM_FetchRow message to a table window if the row you specify is not currently in the table window cache.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
nRow	SalNumber

Returns: SalNumber.

TblFindNextRow(table, row, flagsOn, flagsOff)

Parameter	Type	Description
table	Control
row	SalNumber&
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

TblFindPrevRow(table, row, flagsOn, flagsOff)

Parameter	Type	Description
table	Control
row	SalNumber&
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

TblGetColumnText(table, columnId, text)

Parameter	Type	Description
table	Control
columnId	SalNumber
text	SalString&

Returns: SalBoolean.

TblGetColumnTitle(column, text, maxLen)

Parameter	Type	Description
column	Control
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

TblGetColumnWindow(table, col, flags)

Gets the handle of a table window column.

Parameter	Type	Description
table	Control	Target control on which to execute the call.
col	SalNumber
flags	SalNumber

Returns: SalWindowHandle.

TblInsertRow(table, nRow)

Inserts a new blank row into a table window.

Parameter	Type	Description
table	Control
nRow	SalNumber

Returns: SalNumber.

TblKillEdit(table)

Takes a row out of edit mode and selects the row. This causes the row to receive both SAM_Validate and SAM_KillFocus messages.

Parameter	Type	Description
table	Control

Returns: SalBoolean.

TblKillFocus(table)

Turns off the table window's focus frame.

Parameter	Type	Description
table	Control

Returns: SalBoolean.

TblObjectsFromPoint(table, x, y, row, column, flags)

Parameter	Type	Description
table	Control
x	SalNumber
y	SalNumber
row	SalNumber&
column	SalWindowHandle&
flags	SalNumber&

Returns: SalBoolean.

TblPasteRows(table)

Pastes the contents of the Clipboard to the specified table window. Assumes the Clipboard data is in text format with cells delimited by tab characters and rows delimited by end-of-line characters. Inserts the new rows into the table window without overwriting existing rows, and converts the data to the data types of the corresponding table window columns.

Parameter	Type	Description
table	Control

Returns: SalBoolean.

TblPopulate(table, sql, select, method)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter	Type	Description
table	Control
sql	SalSqlHandle
select	SalString
method	SalNumber

Returns: SalBoolean.

TblPopulate(table, sql, select, method, errorHandler)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter	Type	Description
table	Control
sql	SalSqlHandle
select	SalString
method	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

TblQueryCheckBoxColumn(column, flags, checkedValue, uncheckedValue)

Parameter	Type	Description
column	Control
flags	SalNumber&
checkedValue	SalString&
uncheckedValue	SalString&

Returns: SalBoolean.

TblQueryColumnCellType(column, type)

Parameter	Type	Description
column	Control
type	SalNumber&

Returns: SalBoolean.

TblQueryColumnFlags(column, flags)

Tests the state of a table window column's flags.

Parameter	Type	Description
column	Control
flags	SalNumber

Returns: SalBoolean.

TblQueryColumnID(column)

Gets a table window column's identifier.

Parameter	Type	Description
column	Control

Returns: SalNumber.

TblQueryColumnPos(column)

Gets a table window column's relative position.

Parameter	Type	Description
column	Control

Returns: SalNumber.

TblQueryColumnWidth(column, width)

Parameter	Type	Description
column	Control
width	SalNumber&

Returns: SalBoolean.

TblQueryContext(table)

Returns a table window's current context row. Before sending a SAM_FetchRow message, automatically sets the context row so that assignments made while processing the message reference the correct row.

Parameter	Type	Description
table	Control

Returns: SalNumber.

TblQueryDropDownListColumn(column, flags, lines)

Parameter	Type	Description
column	Control
flags	SalNumber&
lines	SalNumber&

Returns: SalBoolean.

TblQueryFocus(table, row, column)

Parameter	Type	Description
table	Control
row	SalNumber&
column	SalWindowHandle&

Returns: SalBoolean.

TblQueryLinesPerRow(table, nLines)

Parameter	Type	Description
table	Control
nLines	SalNumber&

Returns: SalBoolean.

TblQueryLockedColumns(table)

Retrieves the number of locked table window columns.

Parameter	Type	Description
table	Control

Returns: SalNumber.

TblQueryPopupEditColumn(column, flags, lines)

Parameter	Type	Description
column	Control
flags	SalNumber&
lines	SalNumber&

Returns: SalBoolean.

TblQueryRowFlags(table, row, flags)

Queries a row's flags.

Parameter	Type	Description
table	Control
row	SalNumber
flags	SalNumber

Returns: SalBoolean.

TblQueryRowHeader(table, title, maxTitle, width, flags, windowCol)

Parameter	Type	Description
table	Control
title	SalString&
maxTitle	SalNumber
width	SalNumber&
flags	SalNumber&
windowCol	SalWindowHandle&

Returns: SalBoolean.

TblQueryScroll(table, position, minRange, maxRange)

Parameter	Type	Description
table	Control
position	SalNumber&
minRange	SalNumber&
maxRange	SalNumber&

Returns: SalBoolean.

TblQuerySplitWindow(table, rowsLowerHalf, dragAdjust)

Parameter	Type	Description
table	Control
rowsLowerHalf	SalNumber&
dragAdjust	SalBoolean&

Returns: SalBoolean.

TblQueryTableFlags(table, flags)

Tests the state of a table window's flags.

Parameter	Type	Description
table	Control
flags	SalNumber

Returns: SalBoolean.

TblQueryVisibleRange(table, minRange, maxRange)

Parameter	Type	Description
table	Control
minRange	SalNumber&
maxRange	SalNumber&

Returns: SalBoolean.

TblReset(table)

Clears a table window by discarding all rows from the table window cache and setting the table range to 0, -1.

Parameter	Type	Description
table	Control

Returns: SalBoolean.

TblScroll(table, row, column, flags)

Scrolls a table window to the specified row and column.

Parameter	Type	Description
table	Control
row	SalNumber
column	Control
flags	SalNumber

Returns: SalBoolean.

TblScroll(table, row, column)

Scrolls a table window to the specified row and column.

Parameter	Type	Description
table	Control
row	SalNumber
column	Control

Returns: SalBoolean.

TblSetCellTextColor(column, colorValue, discardable)

Changes a table window cell's text color.

Parameter	Type	Description
column	Control
colorValue	SalNumber
discardable	SalBoolean

Returns: SalBoolean.

TblSetCellTextColor(column, colorValue)

Changes a table window cell's text color.

Parameter	Type	Description
column	Control
colorValue	SalNumber

Returns: SalBoolean.

TblSetColumnFlags(column, flags, set)

Sets or clears a table window column's flags.

Parameter	Type	Description
column	Control
flags	SalNumber
set	SalBoolean

Returns: SalBoolean.

TblSetColumnPos(column, nPos)

Moves a table window column to a new position.

Parameter	Type	Description
column	Control
nPos	SalNumber

Returns: SalBoolean.

TblSetColumnText(table, columndId, text)

Assigns data to a column of a table window's context row.

Parameter	Type	Description
table	Control
columndId	SalNumber
text	SalString

Returns: SalBoolean.

TblSetColumnTitle(column, title)

Sets the title of a table window column.

Parameter	Type	Description
column	Control
title	SalString

Returns: SalBoolean.

TblSetColumnWidth(column, width)

Sets a table window column's display width.

Parameter	Type	Description
column	Control
width	SalNumber

Returns: SalBoolean.

TblSetContext(table, nRow)

Sets a table window's context row. Setting the context row does not send a SAM_FetchRow message. If the row is not currently in memory, creates a new row in memory and sets its cell values to null.

Parameter	Type	Description
table	Control
nRow	SalNumber

Returns: SalBoolean.

TblSetFlagsAnyRows(table, flags, set, flagsOn, flagsOff)

Sets or clears row flags.

Parameter	Type	Description
table	Control
flags	SalNumber
set	SalBoolean
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

TblSetFocusCell(table, row, column)

Sets the focus to the specified table window cell (row and column). Puts the table window into edit mode and lets the user select a portion of the data in the cell.

Parameter	Type	Description
table	Control
row	SalNumber
column	Control

Returns: SalBoolean.

TblSetFocusRow(table, row)

Sets a table window's focus frame row.

Parameter	Type	Description
table	Control
row	SalNumber

Returns: SalBoolean.

TblSetLinesPerRow(table, lines)

Sets the height of a row in lines.

Parameter	Type	Description
table	Control
lines	SalNumber

Returns: SalBoolean.

TblSetLockedColumns(table, lockedColumns)

Sets the number of locked table window columns.

Parameter	Type	Description
table	Control
lockedColumns	SalNumber

Returns: SalBoolean.

TblSetRange(table, min, max)

Defines the minimum and maximum rows (range) of a table.

Parameter	Type	Description
table	Control
min	SalNumber
max	SalNumber

Returns: SalBoolean.

TblSetRow(table, rowPosition)

Sets the focus to the first, last, next, or previous row in a table window.

Parameter	Type	Description
table	Control
rowPosition	SalNumber

Returns: SalNumber.

TblSetRowFlags(table, row, flags, set)

Sets or clears a table window row's flags.

Parameter	Type	Description
table	Control
row	SalNumber
flags	SalNumber
set	SalBoolean

Returns: SalBoolean.

TblSetTableFlags(table, flags, set)

Sets or clears a table window's flags.

Parameter	Type	Description
table	Control
flags	SalNumber
set	SalBoolean

Returns: SalBoolean.

TblSortRows(table, columnId, order)

Sorts the rows of a table window based on the values in one of the table window's columns.

Parameter	Type	Description
table	Control
columnId	SalNumber
order	SalNumber

Returns: SalBoolean.

TimerKill(ctrl, eventId)

Destroys an object's system timer.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
eventId	SalNumber

Returns: SalBoolean.

TimerSet(ctrl, eventId, milliseconds)

Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
eventId	SalNumber
milliseconds	SalNumber

Returns: SalBoolean.

Trace(severity, textToWrite)

Outputs a string to the trace output target.

Parameter	Type	Description
severity	SalNumber
textToWrite	SalString

Returns: SalBoolean.

TrackPopupMenu(owner, menuName, flags, x, y, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
owner	Control
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

TrackPopupMenu(owner, menuType, flags, x, y, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
owner	Control
menuType	Type
flags	SalNumber
x	SalNumber
y	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

TreeCollapseItem(ctrl, hItem)

Collapse a tree item. If the tree item handle is 0, then the top level tree items of the tree control are collapsed.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeDeleteItem(ctrl, hItem)

Removes a tree item from a tree control. All child items of the tree item are also removed.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item was deleted successfully.

TreeDemoteItem(ctrl, hItem)

Moves a tree item so it becomes the child of its previous sibling. This function will fail if the tree item has no previous sibling.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeEditItem(ctrl, hItem)

Allows the user to edit the value of the tree item's label. SAM_Validate is sent to the tree control when the edit control loses focus with wParam indicating the handle to the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if edit has been activated.

TreeEnableItem(ctrl, hItem, bEnable)

Enables the tree item when bEnable is true, disables the tree item when bEnable is false.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bEnable	SalBoolean	Set to TRUE to enable the item. Set to FALSE to disable the item.

Returns: SalBoolean. previous state of the item before this function was called. TRUE if it was enabled, FALSE if it was disabled.

TreeExpandItem(ctrl, hItem)

Expand a tree item. If the tree item handle is 0, then the top level tree items of the tree control are expanded.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeFindItemByData(ctrl, hItem, nData)

Finds a tree item by its Object Data. Returns 0 if not found. Searches the child items of the tree item handle argument(hItem). If the handle is 0, searches the top level tree items.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
nData	SalNumber	Data of the item to find.

Returns: SalNumber. Handle of the tree item whose Data matches the nData parameter.

TreeFindItemByTitle(ctrl, hItem, sTitle)

Finds a tree item by its object title. Returns 0 if not found. Searches the child items of the tree item handle argument. If the handle is 0, searches the top level tree items.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
sTitle	SalString	Title of the item to find.

Returns: SalNumber. Handle of the item whose title matches the sTitle parameter.

TreeGetFirstItem(ctrl, hItem)

Gets the first child tree item of the passed tree item handle. Returns 0 if not found. If the handle is 0, returns the first child of the tree control. If the ShowRootLines attribute is set to Yes, and 0 is passed in, returns the root node of the tree control.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the tree item.

TreeGetItemCount(ctrl, hItem)

Gets the number of child items. If the handle argument is 0, then number of first level child items is returned.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Number of items.

TreeGetItemData(ctrl, hItem)

Returns the numeric value assigned to the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Numeric value assigned to the tree item.

TreeGetItemParent(ctrl, hItem)

Returns the handle of hItem's parent, or 0 if hItem is a top level child of the tree control.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of hItem's parent.

TreeGetItemText(ctrl, hItem)

Returns the string title of the item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalString. String title of the item.

TreeGetItemTooltip(ctrl, hItem)

Returns the current tooltip for the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalString. Current tooltip for the tree item.

TreeGetNextItem(ctrl, hItem)

Gets the next sibling tree item of the passed tree item handle. Returns 0 if there are no more sibling tree items.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the next tree item.

TreeGetPrevItem(ctrl, hItem)

Gets the previous sibling tree item of the passed tree item handle. Returns 0 if there are no more sibling items.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the previous tree item.

TreeGetSelectedItem(ctrl)

Returns the handle to the selected tree item, or 0 if no item is selected.

Parameter	Type	Description
ctrl	Control	Tree control.

Returns: SalNumber. Handle to the selected tree item, or 0 if no item is selected.

TreeInsertItem(ctrl, hItem, nIndex, sTitle)

Inserts a tree item into the tree control. The new item will be a child of nItem.If nItem is 0, the tree item is added as a top level child of the tree control. If nIndex is greater than or equal to the number of child items, or if nIndex is less than zero, the new item is appended.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle of the tree item which will be the parent of the new item.
nIndex	SalNumber	Index to insert (starting at zero).
sTitle	SalString	Title of the new item.

Returns: SalNumber. Handle of the newly created item.

TreeItemHasCheckBox(ctrl, hItem)

Returns true if the tree item has a checkbox displayed.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item has a checkbox displayed, FALSE if not.

TreeItemIsChecked(ctrl, hItem)

Returns true if the item checkbox is checked. Returns false if the checkbox is not displayed.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the checkbox is checked. If the checkbox is not checked, or is not displayed, bIsChecked is FALSE.

TreeItemIsExpanded(ctrl, hItem)

Returns whether the item is expanded.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item is expanded, FALSE if not.

TreeItemIsSelected(ctrl, hItem)

Returns whether the item is selected.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item is selected, FALSE if not.

TreeItemsHaveCheckBoxes(ctrl)

Returns true if the tree shows checkboxes next to the items.

Parameter	Type	Description
ctrl	Control	Tree control.

Returns: SalBoolean. TRUE if the items have a checkbox displayed, FALSE if not.

TreeMoveDownItem(ctrl, hItem)

Moves a tree item downward. This functions fails if the tree item is the last child of its parent.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeMoveItem(ctrl, hItem, hParentItem, nPosition)

Moves a tree node and all its sub-nodes to a new location in the tree control.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
hParentItem	SalNumber	Handle to the new parent tree item.
nPosition	SalNumber	Position in the new parents list of children to place the new child (0-n).

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeMoveUpItem(ctrl, hItem)

Moves a tree item upward . This functions fails if the tree item is the first child of its parent.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreePromoteItem(ctrl, hItem)

Moves a tree item so it becomes the sibling of its parent. This functions fails if the tree item has no grandparent.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeReset(ctrl, bRemove)

Clears a tree control with the option to retain or destroy design-time nodes.

Parameter	Type	Description
ctrl	Control	Tree control.
bRemove	SalBoolean	TRUE = Remove all nodes. FALSE = Remove nodes created dynamically; the tree goes back to the initial state.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it does not succeed.

TreeSetItemChecked(ctrl, hItem, bChecked)

Sets or clears the checkbox. If the checkbox is not displayed, this function has no effect.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bChecked	SalBoolean	TRUE to set the box as checked, FALSE to clear the checkbox.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemData(ctrl, hItem, nValue)

Sets the numeric value of the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
nValue	SalNumber	Value to set.

Returns: SalNumber. Value that was previously assigned to the tree item.

TreeSetItemEditable(ctrl, hItem, bEditable)

Sets whether the tree item's label can be edited. If bEditable is true, the label can be edited.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bEditable	SalBoolean	Whether to enable or disable editing.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemFontEnh(ctrl, hItem, nFontEnh)

Sets the font enhancement for a tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
nFontEnh	SalNumber

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemImage(ctrl, hItem, bSelected, sImageFile)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
sImageFile	SalString	Filename of the image.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemImageFromBinary(ctrl, hItem, bSelected, nFormat, bPicture)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
nFormat	SalNumber	The format of the picture contents: PIC_FormatBitmap, PIC_FormatIcon, PIC_FormatObject
bPicture	SalBinary	The image data to be assigned to the tree node.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemImageFromResource(ctrl, hItem, bSelected, tResource)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
tResource	SalResource	Resource object.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemText(ctrl, hItem, sText)

Sets the title of the item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
sText	SalString	Text to set as the title for this tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemTextColor(ctrl, hItem, nColor)

Sets the text color of the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
nColor	SalNumber	Color to set.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetItemTooltip(ctrl, hItem, sTooltip)

Sets the tooltip for the tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
sTooltip	SalString	Tooltip text.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeSetSelectedItem(ctrl, hItem)

Selects a tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeShowItemCheckBox(ctrl, hItem, bShow)

Shows or hides the checkbox for a tree item.

Parameter	Type	Description
ctrl	Control	Tree control.
hItem	SalNumber	Handle to the tree item.
bShow	SalBoolean	TRUE to show the checkbox, FALSE to hide it.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

TreeShowItemsCheckBoxes(ctrl, bShow)

Shows or hides the checkboxes for a tree control.

Parameter	Type	Description
ctrl	Control	Tree control.
bShow	SalBoolean	TRUE to show the checkboxes, FALSE to hide them.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

UpdateWindow(ctrl)

Forces the update of a window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

UseEventLog(useLog, resume)

Enables logging of unhandled exceptions in the event log.

Parameter	Type	Description
useLog	SalBoolean
resume	SalBoolean

Returns: SalBoolean.

UseRegistry(useRegistry, companyName)

Redirects all SalProfile* functions to use the Registry.

Parameter	Type	Description
useRegistry	SalBoolean
companyName	SalString

Returns: SalBoolean.

ValidateSet(window, state, lParam)

Deprecated: Not supported. Not supported.

Parameter	Type	Description
window	SalWindowHandle
state	SalBoolean
lParam	SalNumber

Returns: SalBoolean.

WaitCursor(bOn)

Displays or removes the hourglass cursor.

Parameter	Type	Description
bOn	SalBoolean

Returns: SalBoolean.

WindowClassName(ctrl)

Return the name of a window's class as a string.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalString.

WindowGetDockSetting(window, orientation)

Parameter	Type	Description
window	SalWindowHandle
orientation	SalNumber&

Returns: SalBoolean.

WindowGetProperty(ctrl, name, value)

Parameter	Type	Description
ctrl	Control
name	SalString
value	SalString&

Returns: SalBoolean.

WindowHandleToNumber(window)

Converts a SalWindowHandle to a number.

Parameter	Type	Description
window	SalWindowHandle	The handle to convert.

Returns: SalNumber. nWnd

WindowHandleToNumber(file)

Converts a SalFileHandle to a number.

Parameter	Type	Description
file	SalFileHandle

Returns: SalNumber.

WindowHandleToNumber(sql)

Converts a SalSqlHandle to a number.

Parameter	Type	Description
sql	SalSqlHandle

Returns: SalNumber.

WindowHandleToNumber(session)

Converts a SalSqlSessionHandle to a number.

Parameter	Type	Description
session	SalSqlSessionHandle

Returns: SalNumber.

WindowIsDerivedFromClass(ctrl, type)

Determines whether a window is an instance of the specified class.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
type	Type

Returns: SalBoolean.

WindowSetProperty(ctrl, name, value, length)

Sets the value of a named property.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

XMLDeserialize<T>(obj, filePath)

Parameter	Type	Description
T
obj	T&
filePath	SalString

Returns: SalBoolean.

XMLGetLastError(errorCode, errorMessage)

Parameter	Type	Description
errorCode	SalNumber&
errorMessage	SalString&

Returns: SalBoolean.

XMLSerialize<T>(obj, filePath)

Serializes the object to a XML file.

Parameter	Type	Description
T
obj	T
filePath	SalString

Returns: SalBoolean.

YieldEnable(set)

Deprecated: Use Sal.Yield(window). Not Supported.

Parameter	Type	Description
set	SalBoolean

Returns: SalBoolean.

YieldQueryState()

Deprecated: Use Sal.Yield(window). Not Supported.

Returns: SalBoolean.

YieldStartMessages(window)

Deprecated: Use Sal.Yield(window). Not Supported.

Parameter	Type	Description
window	SalWindowHandle

Returns: SalBoolean.

YieldStopMessages()

Deprecated: Use Sal.Yield(window). Not Supported.

Returns: SalBoolean.