Sal

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.50 (5.0.0.0)

Provides SAL-compatible functions for migrated application code.

C#
VB.NET

public class Sal

Public Class Sal

Most functions delegate to the corresponding runtime type or control. Return conventions vary by operation; consult each function's return documentation.

Example:

using PPJ.Runtime;

SalNumber red = Sal.ColorFromRGB(255, 0, 0);
SalString caption = "Ready";
SalNumber length = Sal.StrLength(caption);

Properties

Interpreter

ScriptEngine: Gets or sets the expression interpreter used by SAL evaluation.

The getter lazily creates a ScriptEngine with a strict environment when no interpreter is installed.

SalReportType

Type: Gets or sets the report control type instantiated by the SAL reporting functions.

When unset, the getter reads the Sal.SalReportType application setting. If no override is configured, report creation selects an engine from the report file extension. The type must implement ISalReport and have a parameterless constructor.

Methods

Abort(exitCode)

Signals an application-abort request by throwing AbortException.

Parameter	Type	Description
exitCode	SalNumber	Ignored; no exit code is applied.

Returns: SalBoolean. This method does not return.

ActiveXAutoErrorMode(on)

Parameter	Type	Description
on	SalBoolean

Returns: SalBoolean.

ActiveXDoVerb(ctrl, verb, size)

Parameter	Type	Description
ctrl	Control
verb	SalNumber
size	SalBoolean

Returns: SalBoolean.

ActiveXGetObject(ctrl, obj)

Parameter	Type	Description
ctrl	Control
obj	SalObject

Returns: SalBoolean.

AppDisable()

Returns: SalBoolean.

AppEnable()

Returns: SalBoolean.

AppFind(name, activate)

Parameter	Type	Description
name	SalString
activate	SalBoolean

Returns: SalWindowHandle.

ArrayAvg(array)

Parameter	Type	Description
array	SalArray<SalNumber>	The SalArray<SalNumber> value on which to perform the operation.

Returns: SalNumber.

ArrayDimCount(array, dim)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
dim	SalNumber

Returns: SalBoolean.

ArrayGetLowerBound(array, dim, bound)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
dim	SalNumber
bound	SalNumber

Returns: SalBoolean.

ArrayGetUpperBound(array, dim, bound)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
dim	SalNumber
bound	SalNumber

Returns: SalBoolean.

ArrayIsEmpty(array)

Tests whether a SAL array contains any allocated elements.

Parameter	Type	Description
array	SalArray	The non-null SAL array.

Returns: SalBoolean. The array's IsEmpty value.

ArrayMax(array)

Parameter	Type	Description
array	SalArray<SalNumber>	The SalArray<SalNumber> value on which to perform the operation.

Returns: SalNumber.

ArrayMin(array)

Parameter	Type	Description
array	SalArray<SalNumber>	The SalArray<SalNumber> value on which to perform the operation.

Returns: SalNumber.

ArrayQueryBounds(array, min, max)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
min	SalNumber
max	SalNumber

Returns: SalNumber.

ArraySetBounds(array, lower, upper)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
lower	SalNumber
upper	SalNumber

Returns: SalBoolean.

ArraySetUpperBound(array, dim, bound)

Parameter	Type	Description
array	SalArray	The SalArray value on which to perform the operation.
dim	SalNumber
bound	SalNumber

Returns: SalBoolean.

ArraySum(array)

Parameter	Type	Description
array	SalArray<SalNumber>	The SalArray<SalNumber> value on which to perform the operation.

Returns: SalNumber.

BringWindowToTop(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

CenterWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

ClearField(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

ColorFromRGB(red, green, blue)

Creates a SAL color value from red, green, and blue components.

Parameter	Type	Description
red	SalNumber	The red intensity from 0 through 255.
green	SalNumber	The green intensity from 0 through 255.
blue	SalNumber	The blue intensity from 0 through 255.

Returns: SalNumber. The Win32 COLORREF representation of the color.

Values outside the component range cause Color.FromArgb to throw.

ColorGet(ctrl, colorIndex)

Parameter	Type	Description
ctrl	Control
colorIndex	SalNumber

Returns: SalNumber.

ColorGetSysColor(colorIndex)

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

ColorSet(ctrl, colorIndex, colorValue)

Parameter	Type	Description
ctrl	Control
colorIndex	SalNumber
colorValue	SalNumber

Returns: SalBoolean.

ColorToRGB(colorValue, red, green, blue)

Extracts the red, green, and blue components of a color.

Parameter	Type	Description
colorValue	SalNumber	The color to decode.
red	SalNumber	Receives the red component from 0 through 255.
green	SalNumber	Receives the green component from 0 through 255.
blue	SalNumber	Receives the blue component from 0 through 255.

Returns: SalBoolean. True after the operation completes.

ColorToRGB(color, red, green, blue)

Extracts the red, green, and blue components of a color.

Parameter	Type	Description
color	Color	The color to decode.
red	SalNumber	Receives the red component from 0 through 255.
green	SalNumber	Receives the green component from 0 through 255.
blue	SalNumber	Receives the blue component from 0 through 255.

Returns: SalBoolean. True after the operation completes.

CompileAndEvaluate(expression, error, errorPos, numReturn, sReturn, dtReturn, windowReturn, inhibitErrors, context)

Compiles and executes an expression in a supplied variable context.

Parameter	Type	Description
expression	SalString	The expression, optionally prefixed with Set or If.
error	SalNumber	Receives an error code; cleared before evaluation.
errorPos	SalNumber	Receives the error position; cleared before evaluation.
numReturn	SalNumber	Receives a numeric or Boolean result when applicable.
sReturn	SalString	Receives a string result when applicable.
dtReturn	SalDateTime	Receives a date/time result when applicable.
windowReturn	SalWindowHandle	Receives a window-handle result when applicable.
inhibitErrors	SalBoolean	True to return recognized evaluation errors through the receive arguments; false to allow exceptions.
context	Object	The object, SalStringContext, SQL context, or weak reference used for variable resolution.

Returns: SalNumber. An EVAL_ result-type code, or zero on a handled error.

Only the receive argument matching the result type is assigned. Set expressions do not assign a result value.

ContextBreak()

Deprecated: Use this. Retains the ContextBreak operation as a compatibility stub.

Returns: SalString. SalString.Null.

Logs the unsupported call. Reference arguments are left unchanged.

ContextCurrent(context)

Creates a string-evaluation context around an object.

Parameter	Type	Description
context	Object	The object used for variable resolution.

Returns: SalStringContext. A SalStringContext wrapping a temporary SQL context.

ContextMenuSetPopup(ctrl, menuName, flags)

Parameter	Type	Description
ctrl	Control
menuName	SalString
flags	SalNumber

Returns: SalBoolean.

ContextMenuSetPopup(ctrl, menuType, flags)

Parameter	Type	Description
ctrl	Control
menuType	Type
flags	SalNumber

Returns: SalBoolean.

CreateWindow(wndToCreate, parent, parameters)

Parameter	Type	Description
wndToCreate	Type
parent	Control
parameters	Object[]

Returns: SalWindowHandle.

Example:

Create a modeless form and retain its handle for later interaction.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class CustomerWindow : SalFormWindow
{
    public CustomerWindow(SalNumber customerId)
    {
        Text = "Customer " + customerId.ToString();
    }
}

public static class WindowExample
{
    public static SalWindowHandle Open(Control owner)
    {
        SalWindowHandle window = Sal.CreateWindow(
            typeof(CustomerWindow), owner, (SalNumber)42);
        if (!window.IsNull)
            window.SetText("Customer details");
        return window;
    }
}

CreateWindow(formName, parent, parameters)

Creates a modeless SAL form.

Parameter	Type	Description
formName	SalString	The form type name resolved using the calling assembly.
parent	Control	The owner or parent control; required when creating a child form.
parameters	Object[]	Arguments passed through the form creation path.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

Example:

Create a modeless form and retain its handle for later interaction.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class CustomerWindow : SalFormWindow
{
    public CustomerWindow(SalNumber customerId)
    {
        Text = "Customer " + customerId.ToString();
    }
}

public static class WindowExample
{
    public static SalWindowHandle Open(Control owner)
    {
        SalWindowHandle window = Sal.CreateWindow(
            (SalString)typeof(CustomerWindow).FullName, owner, (SalNumber)42);
        if (!window.IsNull)
            window.SetText("Customer details");
        return window;
    }
}

CreateWindow(formName, parent)

Creates a modeless SAL form.

Parameter	Type	Description
formName	SalString	The form type name resolved using the calling assembly.
parent	Control	The owner or parent control; required when creating a child form.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

Example:

Create a modeless form and retain its handle for later interaction.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class CustomerWindow : SalFormWindow
{
    public CustomerWindow()
    {
        Text = "Customers";
    }
}

public static class WindowExample
{
    public static SalWindowHandle Open(Control owner)
    {
        SalWindowHandle window = Sal.CreateWindow(
            (SalString)typeof(CustomerWindow).FullName, owner);
        if (!window.IsNull)
            window.SetText("Customer details");
        return window;
    }
}

CreateWindowEx(wndToCreate, parent, left, top, width, height, flags, parameters)

Creates a modeless SAL form with explicit creation options.

Parameter	Type	Description
wndToCreate	Type	The form type to instantiate.
parent	Control	The owner or parent control; required when creating a child form.
left	SalNumber	The child form's horizontal position in form units.
top	SalNumber	The child form's vertical position in form units.
width	SalNumber	The child form's width in form units.
height	SalNumber	The child form's height in form units.
flags	SalNumber	The combined CREATE_AsChild, CREATE_Hidden, and CREATE_Border options.
parameters	Object[]	Arguments passed through the form creation path.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

The embedded child-form path applies the supplied bounds; other form types retain their normal creation behavior.

CreateWindowEx(formName, parent, left, top, width, height, flags)

Creates a modeless SAL form with explicit creation options.

Parameter	Type	Description
formName	SalString	The form type name resolved using the calling assembly.
parent	Control	The owner or parent control; required when creating a child form.
left	SalNumber	The child form's horizontal position in form units.
top	SalNumber	The child form's vertical position in form units.
width	SalNumber	The child form's width in form units.
height	SalNumber	The child form's height in form units.
flags	SalNumber	The combined CREATE_AsChild, CREATE_Hidden, and CREATE_Border options.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

The embedded child-form path applies the supplied bounds; other form types retain their normal creation behavior.

CreateWindowExFromStr(formName, parent, left, top, width, height, flags)

Creates a modeless SAL form with explicit creation options.

Parameter	Type	Description
formName	SalString	The form type name resolved using the calling assembly.
parent	Control	The owner or parent control; required when creating a child form.
left	SalNumber	The child form's horizontal position in form units.
top	SalNumber	The child form's vertical position in form units.
width	SalNumber	The child form's width in form units.
height	SalNumber	The child form's height in form units.
flags	SalNumber	The combined CREATE_AsChild, CREATE_Hidden, and CREATE_Border options.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

The embedded child-form path applies the supplied bounds; other form types retain their normal creation behavior.

CreateWindowFromStr(formName, parent)

Creates a modeless SAL form.

Parameter	Type	Description
formName	SalString	The form type name resolved using the calling assembly.
parent	Control	The owner or parent control; required when creating a child form.

Returns: SalWindowHandle. A handle to the created form, or a null handle if creation does not retain a live form.

CursorClear(ctrl, type)

Parameter	Type	Description
ctrl	Control
type	SalNumber

Returns: SalBoolean.

CursorSet(ctrl, resource, type)

Loads a cursor resource and assigns it to a control.

Parameter	Type	Description
ctrl	Control	The target control.
resource	SalResourceCursor	The cursor resource to load.
type	SalNumber	The cursor context selector.

Returns: SalBoolean. The result of SalWindow.SetCursor.

CursorSet(ctrl, resourceId, type)

Parameter	Type	Description
ctrl	Control
resourceId	SalNumber
type	SalNumber

Returns: SalBoolean.

CursorSetFile(ctrl, fileName, type)

Parameter	Type	Description
ctrl	Control
fileName	SalString
type	SalNumber

Returns: SalBoolean.

CursorSetString(ctrl, blob, type)

Loads a cursor from SAL string blob data.

Parameter	Type	Description
ctrl	Control	The target control.
blob	SalString	The blob containing cursor data.
type	SalNumber	The cursor context selector.

Returns: SalBoolean. The result of SalWindow.SetCursor.

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

Constructs a SAL date/time from component values.

Parameter	Type	Description
year	SalNumber	The year.
month	SalNumber	The month offset, with January represented by one.
day	SalNumber	The day offset, with the first day represented by one.
hour	SalNumber	The hour offset.
minute	SalNumber	The minute offset.
second	SalNumber	The second offset.

Returns: SalDateTime. The constructed SalDateTime.

The constructor normalizes component overflow by applying offsets to the start of the year.

DateCurrent()

Returns the current local date and time.

Returns: SalDateTime. SalDateTime.Current.

DateDay(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateHour(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateMinute(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateMonth(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateMonthBegin(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalDateTime.

DateQuarter(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateQuarterBegin(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalDateTime.

DateSecond(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateToStr(date, target)

Parameter	Type	Description
date	SalDateTime	The SalDateTime value on which to perform the operation.
target	SalString

Returns: SalNumber.

DateWeekBegin(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalDateTime.

DateWeekday(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateYear(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalNumber.

DateYearBegin(dateTime)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.

Returns: SalDateTime.

DestroyWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

DisableWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

DisableWindowAndLabel(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

DlgChooseColor(ctrl, colorValue)

Displays the color-selection dialog.

Parameter	Type	Description
ctrl	Control	The dialog owner.
colorValue	SalNumber	Receives the accepted SAL color; unchanged if the dialog is canceled.

Returns: SalBoolean. True on acceptance; otherwise, false.

The wrapper initializes the dialog color to zero rather than the incoming receive value.

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

Displays the font-selection dialog and copies an accepted selection to SAL values.

Parameter	Type	Description
ctrl	Control	The dialog owner.
name	SalString	Receives the selected font family.
size	SalNumber	Receives the selected size in points.
enhancements	SalNumber	Receives the FONT_Enh flags.
color	SalNumber	Receives the selected SAL color.

Returns: SalBoolean. True on acceptance; false on cancellation or an unsuccessful dialog operation.

Input receive values do not initialize the dialog; the wrapper starts with empty or zero values.

DlgGetDockStatus(windowDlg, orientation)

Retains the DlgGetDockStatus operation as a compatibility stub.

Parameter	Type	Description
windowDlg	SalWindowHandle	Ignored; no operation is performed.
orientation	SalNumber	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

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

Displays a file-selection dialog.

Parameter	Type	Description
ctrl	Control	The dialog owner.
dialogTitle	SalString	The dialog title.
filters	SalArray<SalString>	Alternating filter descriptions and patterns, beginning at index zero.
filtersCount	SalNumber	The maximum number of filter pairs to read.
filterIndex	SalNumber	The initial filter selection; receives the accepted selection.
fileName	SalString	The initial file name; receives the selected name without its directory.
filePath	SalString	The initial directory or path; receives the selected full path.

Returns: SalBoolean. True if the user accepts a selection; otherwise, false.

Only complete description/pattern pairs are used. Receive arguments are updated after acceptance.

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

Displays a multiple-file selection dialog.

Parameter	Type	Description
ctrl	Control	The dialog owner.
dialogTitle	SalString	The dialog title.
filters	SalArray<SalString>	Alternating filter descriptions and patterns, beginning at index zero.
filtersCount	SalNumber	The maximum number of filter pairs to read.
filterIndex	SalNumber	The initial filter selection; receives the accepted selection.
fileNames	SalArray<SalString>	Receives a new SAL array of selected file names.
filePaths	SalArray<SalString>	Receives a new SAL array of selected full paths.
fileCount	SalNumber	Receives the number of selected files.

Returns: SalBoolean. True if the user accepts a selection; otherwise, false.

Only complete description/pattern pairs are used. Receive arguments are updated after acceptance.

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

Displays a save-file dialog.

Parameter	Type	Description
ctrl	Control	The dialog owner.
dialogTitle	SalString	The dialog title.
filters	SalArray<SalString>	Alternating filter descriptions and patterns, beginning at index zero.
filtersCount	SalNumber	The maximum number of filter pairs to read.
filterIndex	SalNumber	The initial filter selection; receives the accepted selection.
fileName	SalString	The initial file name; receives the selected name without its directory.
filePath	SalString	The initial directory or path; receives the selected full path.

Returns: SalBoolean. True if the user accepts a selection; otherwise, false.

Only complete description/pattern pairs are used. Receive arguments are updated after acceptance.

DlgSetDockStatus(windowDlg, orientation)

Retains the DlgSetDockStatus operation as a compatibility stub.

Parameter	Type	Description
windowDlg	SalWindowHandle	Ignored; no operation is performed.
orientation	SalNumber	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

DragDropDisableDrop()

Disables dropping for the current drag operation.

Returns: SalBoolean. True after the operation completes.

DragDropEnableDrop()

Enables dropping for the current drag operation.

Returns: SalBoolean. True after the operation completes.

DragDropGetSource(window, x, y)

Retrieves the recorded drag-and-drop source.

Parameter	Type	Description
window	SalWindowHandle	Receives the control handle, or a null handle when no control is recorded.
x	SalNumber	Receives the horizontal coordinate, or zero when no control is recorded.
y	SalNumber	Receives the vertical coordinate, or zero when no control is recorded.

Returns: SalBoolean. True after the operation completes.

DragDropGetTarget(windowTarget, x, y)

Retrieves the recorded drag-and-drop target.

Parameter	Type	Description
windowTarget	SalWindowHandle	Receives the control handle, or a null handle when no control is recorded.
x	SalNumber	Receives the horizontal coordinate, or zero when no control is recorded.
y	SalNumber	Receives the vertical coordinate, or zero when no control is recorded.

Returns: SalBoolean. True after the operation completes.

DragDropStart(ctrl)

Starts a SAL drag operation for a control.

Parameter	Type	Description
ctrl	Control	The target control.

Returns: SalBoolean. False when no SalWindow adapter is available; otherwise, the adapter's DragDropStart result.

DragDropStop()

Stops the current SAL drag operation.

Returns: SalBoolean. False when the recorded source has no SalWindow adapter; otherwise, the adapter's DragDropStop result.

DrawMenuBar(ctrl)

Refreshes the main menu of a form.

Parameter	Type	Description
ctrl	Control	The form whose main menu is refreshed; other control types are passed as null.

Returns: SalBoolean. The result of SalWindow.UpdateMainMenu.

DropFilesAcceptFiles(ctrl, accept)

Parameter	Type	Description
ctrl	Control
accept	SalBoolean

Returns: SalBoolean.

DropFilesQueryFiles(ctrl, arrayFiles)

Copies the current drag-and-drop file names into a SAL array.

Parameter	Type	Description
ctrl	Control	Ignored; the current drag data is used.
arrayFiles	SalArray<SalString>	The array to make dynamic, clear, and fill from index zero.

Returns: SalNumber. The number of copied files, or zero when no files are available.

When there are no files, the destination array is left unchanged.

DropFilesQueryPoint(ctrl, x, y)

Copies the recorded drag location to coordinate arguments.

Parameter	Type	Description
ctrl	Control	Ignored; the recorded drag location is used.
x	SalNumber	Receives the horizontal coordinate.
y	SalNumber	Receives the vertical coordinate.

Returns: SalBoolean. True after the operation completes.

EditCanCopy()

Returns: SalBoolean.

EditCanCopyTo()

Deprecated: Not supported. There is no OLE support in .NET. Retains the EditCanCopyTo operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

EditCanCut()

Returns: SalBoolean.

EditCanPaste()

Returns: SalBoolean.

EditCanPasteFrom()

Deprecated: Not supported. There is no OLE support in .NET. Retains the EditCanPasteFrom operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

EditCanUndo()

Returns: SalBoolean.

EditClear()

Returns: SalBoolean.

EditCopy()

Returns: SalBoolean.

EditCopyString(str)

Copies text through the runtime clipboard service.

Parameter	Type	Description
str	SalString	The text to copy.

Returns: SalBoolean. True after the operation completes.

EditCopyTo()

Deprecated: Not supported. There is no OLE support in .NET. Retains the EditCopyTo operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

EditCut()

Returns: SalBoolean.

EditPaste()

Returns: SalBoolean.

EditPasteFrom()

Deprecated: Not supported. There is no OLE support in .NET. Retains the EditPasteFrom operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

EditPasteString(str)

Reads text through the runtime clipboard service.

Parameter	Type	Description
str	SalString	Receives pasted text on success; unchanged on failure.

Returns: SalBoolean. The success result of the clipboard read.

EditUndo()

Returns: SalBoolean.

EnableWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

EnableWindowAndLabel(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

EndDialog(ctrl, returnValue)

Parameter	Type	Description
ctrl	Control
returnValue	SalNumber

Returns: SalBoolean.

EndTrace()

Returns: SalBoolean.

FileClose(file)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.

Returns: SalBoolean.

FileCopy(sourcePath, destPath, overwrite)

Parameter	Type	Description
sourcePath	SalString
destPath	SalString
overwrite	SalBoolean

Returns: SalNumber.

FileCreateDirectory(directory)

Parameter	Type	Description
directory	SalString

Returns: SalBoolean.

FileGetChar(file, charValue)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
charValue	SalNumber

Returns: SalBoolean.

FileGetChar(file)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.

Returns: SalNumber.

FileGetCurrentDirectory(path)

Parameter	Type	Description
path	SalString

Returns: SalBoolean.

FileGetDateTime(fileName, dateTime)

Parameter	Type	Description
fileName	SalString
dateTime	SalDateTime

Returns: SalBoolean.

FileGetDrive()

Returns: SalString.

FileGetStr(file, buffer, bufferSize)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
buffer	SalString
bufferSize	SalNumber

Returns: SalBoolean.

FileOpen(file, fileName, style)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
fileName	SalString
style	SalNumber

Returns: SalBoolean.

FileOpen(file, fileName, style, encoding)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
fileName	SalString
style	SalNumber
encoding	Encoding

Returns: SalBoolean.

FileOpenExt(file, fileName, style, reopen)

Deprecated: Use Sal.FileOpen(). Retains the FileOpenExt operation as a compatibility stub.

Parameter	Type	Description
file	SalFileHandle	Ignored; no operation is performed.
fileName	SalString	Ignored; no operation is performed.
style	SalNumber	Ignored; no operation is performed.
reopen	SalString	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

FilePutChar(file, charValue)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
charValue	SalNumber

Returns: SalBoolean.

FilePutStr(file, str)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
str	SalString

Returns: SalBoolean.

FileRead(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
buffer	SalString
bufferLength	SalNumber

Returns: SalNumber.

FileRead(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
buffer	SalBinary
bufferLength	SalNumber

Returns: SalNumber.

FileRemoveDirectory(directory)

Parameter	Type	Description
directory	SalString

Returns: SalBoolean.

FileSeek(file, bytes, position)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
bytes	SalNumber
position	SalNumber

Returns: SalBoolean.

FileSetCurrentDirectory(path)

Parameter	Type	Description
path	SalString

Returns: SalBoolean.

FileSetDateTime(fileName, dateTime)

Parameter	Type	Description
fileName	SalString
dateTime	SalDateTime

Returns: SalBoolean.

FileSetDrive(sDriveLetter)

Parameter	Type	Description
sDriveLetter	SalString

Returns: SalBoolean.

FileTell(file)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.

Returns: SalNumber.

FileWrite(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
buffer	SalString
bufferLength	SalNumber

Returns: SalNumber.

FileWrite(file, buffer, bufferLength)

Parameter	Type	Description
file	SalFileHandle	The SalFileHandle value on which to perform the operation.
buffer	SalBinary
bufferLength	SalNumber

Returns: SalNumber.

FindWindow(ctrl, windowName)

Parameter	Type	Description
ctrl	Control
windowName	SalString

Returns: SalWindowHandle.

FireWindowActions(ctrl, message, wParam, lParam)

Runs a control's SAL window-action handlers.

Parameter	Type	Description
ctrl	Control	The target control.
message	SalNumber	The action or message identifier.
wParam	SalNumber	The action's wParam.
lParam	SalNumber	The action's lParam.

Returns: SalNumber. The Return value of the resulting window-actions event.

FireWindowActionsToChildren(ctrl, message, wParam, lParam)

Parameter	Type	Description
ctrl	Control
message	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

FmtCopyProfile(ctrl, profile)

Parameter	Type	Description
ctrl	Control
profile	SalNumber

Returns: SalBoolean.

FmtFieldToStr(ctrl, text, format)

Retrieves the control text with optional display formatting.

Parameter	Type	Description
ctrl	Control	The target control.
text	SalString	Receives the result when text is available; unchanged otherwise.
format	SalBoolean	True to apply display formatting; false to request the underlying text.

Returns: SalBoolean. True if text was obtained; otherwise, false.

FmtFormatDateTime(dateTime, sPicture)

Parameter	Type	Description
dateTime	SalDateTime	The SalDateTime value on which to perform the operation.
sPicture	SalString

Returns: SalString.

FmtFormatNumber(num, sPicture)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
sPicture	SalString

Returns: SalString.

FmtGetFormat(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

FmtGetInputMask(ctrl, mask)

Retrieves the input mask of an edit-capable control.

Parameter	Type	Description
ctrl	Control	The target control.
mask	SalString	Receives the input mask when accepted; unchanged when the method returns false.

Returns: SalBoolean. True for a nonempty available mask; false for an empty mask or unsupported control.

FmtGetParmNum(ctrl, parm, value)

Parameter	Type	Description
ctrl	Control
parm	SalNumber
value	SalNumber

Returns: SalBoolean.

FmtGetParmStr(ctrl, parm, value)

Parameter	Type	Description
ctrl	Control
parm	SalNumber
value	SalString

Returns: SalBoolean.

FmtGetPicture(ctrl, format)

Retrieves the display format of an edit-capable control.

Parameter	Type	Description
ctrl	Control	The target control.
format	SalString	Receives the format on success; unchanged if no format is available.

Returns: SalBoolean. True if a non-null format was obtained; otherwise, false.

FmtGetProfile(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

FmtIsValidField(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

FmtIsValidInputMask(mask)

Parameter	Type	Description
mask	SalString

Returns: SalBoolean.

FmtIsValidPicture(format, type)

Parameter	Type	Description
format	SalString
type	SalNumber

Returns: SalBoolean.

FmtKeepMask(keep)

Sets whether masked text retains its mask when retrieved.

Parameter	Type	Description
keep	SalBoolean	True to retain the mask; false to remove it.

Returns: SalBoolean. The newly assigned setting.

FmtSetFormat(ctrl, format)

Parameter	Type	Description
ctrl	Control
format	SalNumber

Returns: SalBoolean.

FmtSetInputMask(ctrl, mask)

Parameter	Type	Description
ctrl	Control
mask	SalString

Returns: SalBoolean.

FmtSetParmNum(ctrl, parm, value)

Parameter	Type	Description
ctrl	Control
parm	SalNumber
value	SalNumber

Returns: SalBoolean.

FmtSetParmStr(ctrl, parm, value)

Parameter	Type	Description
ctrl	Control
parm	SalNumber
value	SalString

Returns: SalBoolean.

FmtSetPicture(ctrl, picture)

Parameter	Type	Description
ctrl	Control
picture	SalString

Returns: SalBoolean.

FmtSetProfile(ctrl, profile)

Parameter	Type	Description
ctrl	Control
profile	SalNumber

Returns: SalBoolean.

FmtStrToField(ctrl, value, format)

Parameter	Type	Description
ctrl	Control
value	SalString
format	SalBoolean

Returns: SalBoolean.

FmtUnmaskInput(ctrl, text)

Retrieves control text with input-mask literals removed.

Parameter	Type	Description
ctrl	Control	The target control.
text	SalString	Receives the unmasked text on success; unchanged when the control is unavailable.

Returns: SalBoolean. True if the control was available; otherwise, false.

FmtValidateField(ctrl, validate)

Validates the current field value.

Parameter	Type	Description
ctrl	Control	The control to validate.
validate	SalNumber	FMT_Validate_Dialog to request an error dialog; other values suppress it.

Returns: SalBoolean. The result of SalWindow.Validate.

FontGet(ctrl, name, size, enhancement)

Parameter	Type	Description
ctrl	Control
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

FontGetNames(type, fonts)

Copies available font family names into a SAL array.

Parameter	Type	Description
type	SalNumber	Ignored; printer and screen fonts are not distinguished by this wrapper.
fonts	SalArray<SalString>	The array to make dynamic, clear, and populate from index zero.

Returns: SalNumber. The number of copied names, or zero if none are available.

The destination remains unchanged when no font names are available.

FontGetSizes(get, fontName, fontSizes)

Deprecated: Use FontFamilies instead. Retains the FontGetSizes operation as a compatibility stub.

Parameter	Type	Description
get	SalNumber	Ignored; no operation is performed.
fontName	SalString	Ignored; no operation is performed.
fontSizes	SalArray<SalNumber>	Ignored; no operation is performed.

Returns: SalNumber. False.

Logs the unsupported call. Reference arguments are left unchanged.

FontSet(ctrl, name, size, enhancement)

Parameter	Type	Description
ctrl	Control
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

FormGetParmNum(ctrl, paramType, value)

Parameter	Type	Description
ctrl	Control
paramType	SalNumber
value	SalNumber

Returns: SalBoolean.

FormUnitsToPixels(ctrl, formUnits, vertical)

Parameter	Type	Description
ctrl	Control	The target control.
formUnits	SalNumber
vertical	SalBoolean

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetBufferLength(buffer)

Parameter	Type	Description
buffer	SalBinary	The SalBinary value on which to perform the operation.

Returns: SalNumber.

GetBufferLength(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalNumber.

GetDataType(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

GetDefButton(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalWindowHandle.

GetFirstChild(ctrl, typeMask)

Parameter	Type	Description
ctrl	Control
typeMask	SalNumber

Returns: SalWindowHandle.

GetFocus()

Returns: SalWindowHandle.

GetHintText(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalString.

GetItemName(ctrl, name)

Parameter	Type	Description
ctrl	Control
name	SalString

Returns: SalBoolean.

GetMaxDataLength(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

GetNextChild(ctrl, typeMask)

Parameter	Type	Description
ctrl	Control
typeMask	SalNumber

Returns: SalWindowHandle.

GetProfileInt(section, entry, defaultValue, fileName)

Reads an integer profile setting through SalApplication.

Parameter	Type	Description
section	SalString	The profile section.
entry	SalString	The entry name.
defaultValue	SalNumber	The fallback value, converted to an unsigned 32-bit integer before lookup.
fileName	SalString	The profile file name.

Returns: SalNumber. The integer returned by SalApplication.GetProfileInt.

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

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

Returns: SalNumber.

GetReportObject(handle)

Finds the report control identified by a control handle.

Parameter	Type	Description
handle	IntPtr	The handle of the report or a control containing the report.

Returns: ISalReport. The report implementation, or null when none is found.

If the control itself is not a report, its child controls are searched.

GetVersion()

Returns the runtime application version value.

Returns: SalNumber. SalApplication.Version.

GetWindowLabel(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalWindowHandle.

GetWindowLabelText(ctrl, text, maxLength)

Parameter	Type	Description
ctrl	Control
text	SalString
maxLength	SalNumber

Returns: SalNumber.

GetWindowLoc(ctrl, x, y)

Retrieves a control's location in form units.

Parameter	Type	Description
ctrl	Control	The target control.
x	SalNumber	Receives the horizontal location.
y	SalNumber	Receives the vertical location.

Returns: SalBoolean. True after the operation completes.

GetWindowSize(ctrl, width, height)

Retrieves a control's size in form units.

Parameter	Type	Description
ctrl	Control	The target control.
width	SalNumber	Receives the width.
height	SalNumber	Receives the height.

Returns: SalBoolean. True after the operation completes.

GetWindowState(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

GetWindowText(ctrl, text, maxLen)

Parameter	Type	Description
ctrl	Control
text	SalString
maxLen	SalNumber

Returns: SalNumber.

HideWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

HideWindowAndLabel(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

HStringToNumber(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalNumber.

IdleKick()

Returns: SalBoolean.

IdleRegisterWindow(ctrl, message, wParam, lParam)

Parameter	Type	Description
ctrl	Control
message	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

IdleUnregisterWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

InvalidateWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsButtonChecked(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsNull(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsValidDateTime(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsValidDecimal(ctrl, precision, scale)

Parameter	Type	Description
ctrl	Control
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

IsValidInteger(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsValidNumber(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsWindowEnabled(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

IsWindowVisible(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

JSONDeserializeUDV<T>(obj, urlOrJson, userName, password, error)

Deserializes JSON text or attempts to retrieve and deserialize JSON from a URL.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	Receives the deserialized value; initialized to default(T).
urlOrJson	SalString	JSON text, or an absolute URL from which to request JSON with HTTP GET.
userName	SalString	The optional Basic-authentication user name.
password	SalString	The Basic-authentication password.
error	SalString	Receives an exception message on failure; initially empty.

Returns: SalBoolean. True if processing completes without an exception; false for empty input or a caught exception.

An empty response leaves the result at default(T). The URL path dereferences null header and parameter arrays; the overload without arrays therefore fails for URL input. Use non-null arrays with the Ex overload.

JSONDeserializeUDVEx<T>(obj, urlOrJson, userName, password, headers, parameters, error)

Deserializes JSON text or attempts to retrieve and deserialize JSON from a URL.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	Receives the deserialized value; initialized to default(T).
urlOrJson	SalString	JSON text, or an absolute URL from which to request JSON with HTTP GET.
userName	SalString	The optional Basic-authentication user name.
password	SalString	The Basic-authentication password.
headers	SalArray<SalString>	Two-dimensional request-header name/value entries. For URL input, pass a non-null array, even when empty.
parameters	SalArray<SalString>	Two-dimensional query name/value entries. For URL input, pass a non-null array, even when empty.
error	SalString	Receives an exception message on failure; initially empty.

Returns: SalBoolean. True if processing completes without an exception; false for empty input or a caught exception.

JSONSerializeUDV<T>(obj, url, httpVerb, result, userName, password, error)

Serializes a value to JSON and optionally sends it in an HTTP request.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	The value to serialize; null causes failure.
url	SalString	An endpoint URL, or an empty/null SAL string to return JSON without sending a request.
httpVerb	SalNumber	The HTTP method: HTTP_GET, HTTP_PUT, HTTP_POST, or HTTP_DELETE.
result	SalString	Receives serialized JSON or the HTTP response body; initially SalString.Null.
userName	SalString	The optional Basic-authentication user name.
password	SalString	The Basic-authentication password.
error	SalString	Receives an exception message on failure; initially empty.

Returns: SalBoolean. True on successful serialization or HTTP response; false for a null object or a caught exception.

HTTP execution is synchronous. A supplied URL receives the JSON as the request body, including for GET and DELETE. HTTP failures are reported through the error argument.

JSONSerializeUDVEx<T>(obj, url, httpVerb, result, userName, password, headers, parameters, error)

Serializes a value to JSON and optionally sends it in an HTTP request.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	The value to serialize; null causes failure.
url	SalString	An endpoint URL, or an empty/null SAL string to return JSON without sending a request.
httpVerb	SalNumber	The HTTP method: HTTP_GET, HTTP_PUT, HTTP_POST, or HTTP_DELETE.
result	SalString	Receives serialized JSON or the HTTP response body; initially SalString.Null.
userName	SalString	The optional Basic-authentication user name.
password	SalString	The Basic-authentication password.
headers	SalArray	Optional two-dimensional name/value entries added to request headers.
parameters	SalArray	Optional two-dimensional name/value entries used to replace the URL query.
error	SalString	Receives an exception message on failure; initially empty.

Returns: SalBoolean. True on successful serialization or HTTP response; false for a null object or a caught exception.

HTTP execution is synchronous. A supplied URL receives the JSON as the request body, including for GET and DELETE. HTTP failures are reported through the error argument.

ListAdd(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString

Returns: SalNumber.

ListClear(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

ListDelete(ctrl, index)

Parameter	Type	Description
ctrl	Control
index	SalNumber

Returns: SalNumber.

ListFiles(ctrl, ctrlPath, pathName, attributes)

Parameter	Type	Description
ctrl	Control
ctrlPath	Control
pathName	SalString
attributes	SalNumber

Returns: SalBoolean.

ListGetMultiSelect(ctrl, selectedArray)

Parameter	Type	Description
ctrl	Control
selectedArray	SalArray<SalNumber>

Returns: SalBoolean.

ListInsert(ctrl, index, text)

Parameter	Type	Description
ctrl	Control
index	SalNumber
text	SalString

Returns: SalNumber.

ListPopulate(ctrl, sql, select)

Parameter	Type	Description
ctrl	Control
sql	SalSqlHandle
select	SalString

Returns: SalBoolean.

ListPopulate(ctrl, sql, select, errorHandler)

Parameter	Type	Description
ctrl	Control
sql	SalSqlHandle
select	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

ListQueryCount(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

ListQueryFile(ctrl, fileName)

Parameter	Type	Description
ctrl	Control
fileName	SalString

Returns: SalBoolean.

ListQueryMultiCount(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

ListQuerySelection(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalNumber.

ListQueryState(ctrl, index)

Parameter	Type	Description
ctrl	Control
index	SalNumber

Returns: SalBoolean.

ListQueryText(ctrl, index, text)

Parameter	Type	Description
ctrl	Control
index	SalNumber
text	SalString

Returns: SalNumber.

ListQueryTextLength(ctrl, index)

Parameter	Type	Description
ctrl	Control
index	SalNumber

Returns: SalNumber.

ListQueryTextX(ctrl, index)

Parameter	Type	Description
ctrl	Control
index	SalNumber

Returns: SalString.

ListRedraw(ctrl, redraw)

Parameter	Type	Description
ctrl	Control	The target control.
redraw	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ListSelectString(ctrl, startIndex, text)

Parameter	Type	Description
ctrl	Control
startIndex	SalNumber
text	SalString

Returns: SalNumber.

ListSetMultiSelect(ctrl, index, select)

Parameter	Type	Description
ctrl	Control
index	SalNumber
select	SalBoolean

Returns: SalBoolean.

ListSetSelect(ctrl, index)

Parameter	Type	Description
ctrl	Control
index	SalNumber

Returns: SalBoolean.

ListSetTabs(ctrl, tabStops)

Parameter	Type	Description
ctrl	Control
tabStops	SalArray<SalNumber>

Returns: SalBoolean.

LoadApp(name, parameters)

Parameter	Type	Description
name	SalString
parameters	SalString

Returns: SalBoolean.

LoadAppAndProcessMsgs(name, mode, retCode)

Parameter	Type	Description
name	SalString
mode	SalNumber
retCode	SalNumber

Returns: SalBoolean.

LoadAppAndWait(name, mode, retCode)

Parameter	Type	Description
name	SalString
mode	SalNumber
retCode	SalNumber

Returns: SalBoolean.

Log(fileName, message)

Appends text to a log file.

Parameter	Type	Description
fileName	SalString	The destination path.
message	SalString	The text to append without adding a newline.

Returns: SalBoolean. True if the write succeeds; false if a caught exception is logged.

LogLine(fileName, message)

Invokes Log with a line terminator appended to the file name.

Parameter	Type	Description
fileName	SalString	The destination path to which CRLF is appended by this implementation.
message	SalString	The text passed unchanged to Log.

Returns: SalBoolean. The result of Log.

This implementation adds CRLF to the file-name argument, not to the message. It can therefore fail to open the file.

LogResource(fileName)

Deprecated: Use Sal.Log(). Retains the LogResource operation as a compatibility stub.

Parameter	Type	Description
fileName	SalString	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

MapEnterToTab(state)

Sets whether Enter behaves as Tab for SAL controls.

Parameter	Type	Description
state	SalBoolean	True to enable the mapping; false to disable it.

Returns: SalBoolean. The newly assigned setting.

MDIArrangeIcons(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

MDICascade(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

MDITile(ctrl, position)

Parameter	Type	Description
ctrl	Control
position	SalBoolean

Returns: SalBoolean.

MessageBeep(alertLevel)

Parameter	Type	Description
alertLevel	SalNumber

Returns: SalBoolean.

MessageBox(text)

Displays a message box using SAL options.

Parameter	Type	Description
text	SalString	The message text.

Returns: SalNumber. The ID constant corresponding to the selected button.

Uses an empty title and the default OK button.

MessageBox(text, title, flags)

Displays a message box using SAL options.

Parameter	Type	Description
text	SalString	The message text.
title	SalString	The message-box title.
flags	SalNumber	Combined MB_ button, icon, and default-button options.

Returns: SalNumber. The ID constant corresponding to the selected button.

MessageBox(owner, text, title, flags)

Parameter	Type	Description
owner	Control
text	SalString
title	SalString
flags	SalNumber

Returns: SalNumber.

ModalDialog(dialogType, owner, parameters)

Parameter	Type	Description
dialogType	Type
owner	Control
parameters	Object[]

Returns: SalNumber.

Example:

Use an explicit dialog return value to distinguish acceptance from closing the dialog.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class ConfirmationDialog : SalDialogBox
{
    public ConfirmationDialog(SalString prompt)
    {
        Text = prompt;
        var accept = new Button { Text = "OK" };
        accept.Click += (sender, e) => Sal.EndDialog(this, 1);
        Controls.Add(accept);
    }
}

public static class DialogExample
{
    public static bool Confirm(Control owner)
    {
        SalNumber result = Sal.ModalDialog(typeof(ConfirmationDialog), owner, (SalString)"Confirm changes");
        return result == 1;
    }
}

ModalDialog(dialogName, owner, parameters)

Creates and displays a modal SAL dialog.

Parameter	Type	Description
dialogName	SalString	The dialog type name resolved using the calling assembly.
owner	Control	The dialog owner.
parameters	Object[]	Arguments passed through the dialog creation path.

Returns: SalNumber. The dialog's SAL return value.

Example:

Use an explicit dialog return value to distinguish acceptance from closing the dialog.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class ConfirmationDialog : SalDialogBox
{
    public ConfirmationDialog(SalString prompt)
    {
        Text = prompt;
        var accept = new Button { Text = "OK" };
        accept.Click += (sender, e) => Sal.EndDialog(this, 1);
        Controls.Add(accept);
    }
}

public static class DialogExample
{
    public static bool Confirm(Control owner)
    {
        SalNumber result = Sal.ModalDialog((SalString)typeof(ConfirmationDialog).FullName, owner, (SalString)"Confirm changes");
        return result == 1;
    }
}

ModalDialog(dialogName, owner)

Creates and displays a modal SAL dialog.

Parameter	Type	Description
dialogName	SalString	The dialog type name resolved using the calling assembly.
owner	Control	The dialog owner.

Returns: SalNumber. The dialog's SAL return value.

Example:

Use an explicit dialog return value to distinguish acceptance from closing the dialog.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class ConfirmationDialog : SalDialogBox
{
    public ConfirmationDialog()
    {
        Text = "Confirm changes";
        var accept = new Button { Text = "OK" };
        accept.Click += (sender, e) => Sal.EndDialog(this, 1);
        Controls.Add(accept);
    }
}

public static class DialogExample
{
    public static bool Confirm(Control owner)
    {
        SalNumber result = Sal.ModalDialog((SalString)typeof(ConfirmationDialog).FullName, owner);
        return result == 1;
    }
}

ModalDialogFromStr(dialogName, owner)

Creates and displays a modal SAL dialog.

Parameter	Type	Description
dialogName	SalString	The dialog type name resolved using the calling assembly.
owner	Control	The dialog owner.

Returns: SalNumber. The dialog's SAL return value.

MoveWindow(ctrl, xOffset, yOffset)

Moves a control by offsets expressed in form units.

Parameter	Type	Description
ctrl	Control	The target control.
xOffset	SalNumber	The horizontal offset.
yOffset	SalNumber	The vertical offset.

Returns: SalBoolean. The result of SalWindow.Move.

MTSCreateInstance(obj)

Retains the MTSCreateInstance operation as a compatibility stub.

Parameter	Type	Description
obj	Object	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

MTSDisableCommit()

Disables transaction commit in the current COM+ context.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSEnableCommit()

Enables transaction commit in the current COM+ context.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSGetObjectContext(obj, context)

Deprecated: Not supported. Retains the MTSGetObjectContext operation as a compatibility stub.

Parameter	Type	Description
obj	Object	Ignored; no operation is performed.
context	SalNumber	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

MTSIsCallerInRole(role, inRole)

Queries whether the caller belongs to a COM+ role.

Parameter	Type	Description
role	SalString	The role name.
inRole	SalBoolean	Receives the queried state on success; unchanged after a caught COMException.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSIsInTransaction(isInTransaction)

Queries whether the COM+ context belongs to a transaction.

Parameter	Type	Description
isInTransaction	SalBoolean	Receives the queried state on success; unchanged after a caught COMException.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSIsSecurityEnabled(isSecurityEnabled)

Queries COM+ security and discards the returned state.

Parameter	Type	Description
isSecurityEnabled	SalBoolean	Left unchanged; this implementation discards the queried value.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSSetAbort()

Marks the current COM+ work as aborted.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

MTSSetComplete()

Marks the current COM+ work as complete.

Returns: SalBoolean. True if the call completes; false if a COMException is caught and logged.

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

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
groupIndex	SalNumber
groupTitle	SalString
height	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavAddPane(control, paneIndex, name, expandedImage, collapsedImage)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
name	SalString
expandedImage	SalString
collapsedImage	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavAssociateChild(control, paneIndex, groupIndex, child)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
groupIndex	SalNumber
child	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavDisassociateChild(control, paneIndex, child)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
child	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavEnablePane(control, paneIndex, enable)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
enable	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavExpandGroup(control, paneIndex, groupIndex, expand)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
groupIndex	SalNumber
expand	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavGetActivePane(control)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.

Returns: SalNumber. For an incompatible control, -1; otherwise,

NavGetPaneIcon(control, paneIndex, binary, format, expanded)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
binary	SalBinary
format	SalNumber
expanded	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavGetPaneIndex(control, name)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
name	SalString

Returns: SalNumber. For an incompatible control, -1; otherwise,

NavGetPaneTitle(control, paneIndex, title)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
title	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavGetPaneTitle(control, paneIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber

Returns: SalString. For an incompatible control, SalString.Null; otherwise,

NavGroupIsExpanded(control, paneIndex, groupIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
groupIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavLoadState(control, xml)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
xml	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavPaneIsEnabled(control, paneIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavRemoveGroup(control, paneIndex, groupIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
groupIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavRemovePane(control, paneIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavSaveState(control, xml)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
xml	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavSetActivePane(control, paneIndex)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavSetPaneIcon(control, paneIndex, binary, format, expanded)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
binary	SalBinary
format	SalNumber
expanded	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NavSetPaneTitle(control, paneIndex, title)

Parameter	Type	Description
control	Control	The control resolved as SalNavigationBar value on which to perform the operation.
paneIndex	SalNumber
title	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

NumberAbs(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberArcCos(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberArcSin(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberArcTan(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberArcTan2(numY, numX)

Parameter	Type	Description
numY	SalNumber
numX	SalNumber

Returns: SalNumber.

NumberCos(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberCosH(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberExponent(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberHigh(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberHypot(x, y)

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalNumber.

NumberLog(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberLogBase10(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberLow(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberMax(num1, num2)

Parameter	Type	Description
num1	SalNumber
num2	SalNumber

Returns: SalNumber.

NumberMin(num1, num2)

Parameter	Type	Description
num1	SalNumber
num2	SalNumber

Returns: SalNumber.

NumberMod(num, mod)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
mod	SalNumber

Returns: SalNumber.

NumberPi(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberPower(num, exponent)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
exponent	SalNumber

Returns: SalNumber.

NumberRandInit(seed)

Parameter	Type	Description
seed	SalNumber

Returns: SalBoolean.

NumberRandom()

Returns: SalNumber.

NumberRound(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberSin(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberSinH(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberSqrt(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberTan(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberTanH(angle)

Parameter	Type	Description
angle	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalNumber.

NumberToChar(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalString.

NumberToHString(handle)

Resolves a registered SAL string handle.

Parameter	Type	Description
handle	SalNumber	The numeric string handle.

Returns: SalString. The string returned by SalString.FromHandle.

NumberToStr(num, decimalPlaces, str)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
decimalPlaces	SalNumber
str	SalString

Returns: SalNumber.

NumberToStrX(num, decimalPlaces)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
decimalPlaces	SalNumber

Returns: SalString.

NumberToWindowHandle(num)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.

Returns: SalWindowHandle.

NumberTruncate(num, precision, scale)

Parameter	Type	Description
num	SalNumber	The SalNumber value on which to perform the operation.
precision	SalNumber
scale	SalNumber

Returns: SalNumber.

ObjCreateFromString(className)

Creates a migrated functional-class instance by name.

Parameter	Type	Description
className	SalString	The class name resolved using the calling assembly.

Returns: SalFunctionalClass. The result of SalFunctionalClass.CreateFromString.

ObjGetType(userObject)

Returns the SAL type name of a functional-class instance.

Parameter	Type	Description
userObject	SalFunctionalClass	The instance to inspect.

Returns: SalString. The GetTypeName result, or an empty SAL string for a null reference.

ObjIsDerived(userObject, className)

Tests whether a functional-class instance derives from a named class.

Parameter	Type	Description
userObject	SalFunctionalClass	The instance to inspect.
className	SalString	The base-class name resolved using the calling assembly.

Returns: SalBoolean. False for a null instance; otherwise, the IsDerivedFrom result.

ObjIsNull(userObject)

Tests whether a migrated functional-class reference is null.

Parameter	Type	Description
userObject	SalFunctionalClass	The object reference to test.

Returns: SalBoolean. True if the reference is null; otherwise, false.

ObjIsValidClasname(className)

Checks whether a name resolves to a valid functional class.

Parameter	Type	Description
className	SalString	The class name resolved using the calling assembly.

Returns: SalBoolean. The result of SalFunctionalClass.IsValidClassName.

ParentWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalWindowHandle.

Pause(milliseconds)

Suspends the calling thread for the requested interval.

Parameter	Type	Description
milliseconds	SalNumber	The sleep duration in milliseconds, converted to an integer; -1 waits indefinitely.

Returns: SalBoolean. True after the operation completes.

PicClear(ctrl)

Clears the image assigned to the associated control.

Parameter	Type	Description
ctrl	Control	The target control.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

PicGetDescription(ctrl, description, maxLen)

Retrieves the Gupta image-format description.

Parameter	Type	Description
ctrl	Control	The target control.
description	SalString	Receives the description, or an empty string if no image is available.
maxLen	SalNumber	The maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

PicGetImage(ctrl, buffer, type)

Encodes the current image as binary data and reports its format.

Parameter	Type	Description
ctrl	Control	The target control.
buffer	SalString	Receives the image data, or a null-valued buffer when no image is available.
type	SalNumber	Receives the image-type code.

Returns: SalNumber. The byte count, or zero when no image data is available.

PicGetImage(ctrl, buffer, type)

Encodes the current image as binary data and reports its format.

Parameter	Type	Description
ctrl	Control	The target control.
buffer	SalBinary	Receives the image data, or a null-valued buffer when no image is available.
type	SalNumber	Receives the image-type code.

Returns: SalNumber. The byte count, or zero when no image data is available.

PicGetString(ctrl, format, buffer)

Encodes the current image in a requested SAL image representation.

Parameter	Type	Description
ctrl	Control	The target control.
format	SalNumber	The PIC_Format* encoding selector.
buffer	SalString	Receives the encoded image data.

Returns: SalNumber. The number of encoded bytes.

The object format includes a Gupta header and requires an available image. Other formats can return an empty blob when no image is available.

PicGetString(ctrl, format, buffer)

Encodes the current image in a requested SAL image representation.

Parameter	Type	Description
ctrl	Control	The target control.
format	SalNumber	The PIC_Format* encoding selector.
buffer	SalBinary	Receives the encoded image data.

Returns: SalNumber. The number of encoded bytes.

The binary overload returns raw encoded bytes.

PicSet(ctrl, resourceType, format)

Loads an image from a SAL resource and assigns it to the control.

Parameter	Type	Description
ctrl	Control	The target control.
resourceType	SalResource	The image resource to load.
format	SalNumber	The image-format selector passed to the picture implementation.

Returns: SalBoolean. True if the image can be assigned to the control; otherwise, false.

PicSetFile(ctrl, fileName)

Loads and assigns an image from a file.

Parameter	Type	Description
ctrl	Control	The target control.
fileName	SalString	The file path, or an empty value to clear the image.

Returns: SalBoolean. True if assignment succeeds; false if the control does not support images or a file I/O error is caught.

PicSetFit(ctrl, fit, scaleWidth, scaleHeight)

Sets how a picture is fitted within its control.

Parameter	Type	Description
ctrl	Control	The target control.
fit	SalNumber	The PIC_Fit* fitting mode.
scaleWidth	SalNumber	The width scaling percentage used for PIC_FitScale.
scaleHeight	SalNumber	The height scaling percentage used for PIC_FitScale.

Returns: SalBoolean. True for a supported picture control; otherwise, false.

Best-fit and size-to-fit modes reset the scaling percentages to 100.

PicSetHandle(ctrl, type, handle)

Assigns an image identified by a native icon or bitmap handle.

Parameter	Type	Description
ctrl	Control	The target control.
type	SalNumber	The native handle, or zero to clear the image.
handle	SalNumber	PIC_FormatIcon for an icon; other values use the bitmap path.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

PicSetImage(ctrl, buffer, type)

Decodes image bytes and assigns the resulting image.

Parameter	Type	Description
ctrl	Control	The target control.
buffer	SalString	The encoded image data.
type	SalNumber	The SAL image-format code passed to the decoder.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

PicSetString(ctrl, format, buffer)

Decodes image bytes and assigns the resulting image.

Parameter	Type	Description
ctrl	Control	The target control.
format	SalNumber	The SAL image-format code passed to the decoder.
buffer	SalString	The encoded image data.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

PicSetString(ctrl, format, buffer)

Loads a picture from a binary image buffer.

Parameter	Type	Description
ctrl	Control	The target control.
format	SalNumber	The image format identifier.
buffer	SalBinary	The encoded image bytes.

Returns: SalBoolean. The result of SalPicture.SetImageString.

PixelsToFormUnits(ctrl, numPixels, vertical)

Parameter	Type	Description
ctrl	Control
numPixels	SalNumber
vertical	SalBoolean

Returns: SalNumber.

PostMsg(ctrl, msg, wParam, lParam)

Parameter	Type	Description
ctrl	Control	The target control.
msg	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

Example:

Queue a custom action for later dispatch; the return value reports posting success, not the handler result.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class MessageWindow : SalFormWindow
{
    private const int RefreshCaption = Sys.SAM_User + 1;

    public MessageWindow()
    {
        WindowActions += (sender, e) =>
        {
            if (e.ActionType == RefreshCaption)
            {
                Text = "Refreshed";
                e.Return = 1;
            }
        };
    }

    public SalBoolean RequestRefresh()
    {
        // Call on a live window from the UI thread.
        return Sal.PostMsg(this, RefreshCaption, 0, 0);
    }
}

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

Extracts the rectangle carried by a print-message GCHandle.

Parameter	Type	Description
lParam	SalNumber	A GCHandle identifier whose target is a boxed Rectangle.
left	SalNumber	Receives the left edge.
top	SalNumber	Receives the top edge.
right	SalNumber	Receives the right edge.
bottom	SalNumber	Receives the bottom edge.

Returns: SalBoolean. False for a zero handle; true after extracting the rectangle.

Nonzero handles must be valid GCHandles with Rectangle targets. The method does not release the handle.

PrtGetDefault(device, driver, port)

Retrieves the default printer name.

Parameter	Type	Description
device	SalString	Receives the system default printer name.
driver	SalString	Receives the same printer name, rather than a driver identifier.
port	SalString	Ignored and left unchanged.

Returns: SalBoolean. True if the Windows default-printer lookup succeeds; otherwise, false.

PrtGetParmNum(parm, value)

Reads a supported numeric print setting.

Parameter	Type	Description
parm	SalNumber	The PRT_n parameter identifier.
value	SalNumber	Receives the setting; unchanged for an unsupported parameter.

Returns: SalBoolean. True for a recognized parameter; otherwise, false.

Margin values are divided by 100 using integer arithmetic, so fractional inches are discarded.

PrtPreviewForm(ctrl)

Previews a form through the SAL printing service.

Parameter	Type	Description
ctrl	Control	The form to process.

Returns: SalBoolean. False for a null/non-form control or a caught exception; otherwise, true.

PrtPrintForm(ctrl)

Prints a form through the SAL printing service.

Parameter	Type	Description
ctrl	Control	The form to process.

Returns: SalBoolean. False for a null/non-form control or a caught exception; otherwise, true.

PrtSetDefault(device, driver, port)

Sets the Windows default printer.

Parameter	Type	Description
device	SalString	The printer name.
driver	SalString	Ignored.
port	SalString	Ignored.

Returns: SalBoolean. True if the Windows operation succeeds; otherwise, false.

PrtSetParmDefaults()

Resets cached printer settings and disables the printed form border.

Returns: SalBoolean. True.

PrtSetParmNum(parm, value)

Changes a supported numeric print setting.

Parameter	Type	Description
parm	SalNumber	The PRT_n parameter identifier.
value	SalNumber	The new setting; margins are specified in inches.

Returns: SalBoolean. True for a recognized parameter; otherwise, false.

Margin values are multiplied by 100. Print-all sets both page limits to zero; clearing it sets only the first page to one. Draft selection takes the first matching draft or medium resolution encountered.

PrtSetup(device, driver, port, activeOnly)

Displays printer setup and makes the accepted printer the Windows default.

Parameter	Type	Description
device	SalString	Receives the accepted default printer name.
driver	SalString	Receives the same printer name.
port	SalString	Ignored and left unchanged.
activeOnly	SalBoolean	Ignored; does not limit printer selection.

Returns: SalBoolean. True if acceptance, default-printer assignment, and name retrieval all succeed; otherwise, false.

QueryFieldEdit(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

Quit()

Signals an application-quit request by throwing QuitException.

Returns: SalBoolean. This method does not return.

RegexReplaceAll(strInput, nStart, nEnd, strRegex, result)

Removes every regular-expression match within a character range.

Parameter	Type	Description
strInput	SalString	The input text; null is treated as empty.
nStart	SalNumber	The one-based inclusive start position; values below one become one.
nEnd	SalNumber	The one-based inclusive end position; nonpositive or oversized values become the input length.
strRegex	SalString	The pattern whose matches are removed.
result	SalString	Receives the resulting text.

Returns: SalString. The same text assigned to result.

Text outside the range is preserved. An empty pattern, reversed range, or caught exception returns the original input.

ReportClose(windowReport)

Closes the preview associated with a report window.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.

Returns: SalBoolean. True if the report was found and the close command was dispatched; otherwise, false.

ReportCmd(windowReport, command)

Dispatches a preview command to a report window.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
command	SalNumber	The preview command code understood by the reporting engine.

Returns: SalBoolean. True if the report was found and the command was dispatched; otherwise, false.

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

Creates a report file from the supplied variable and input definitions.

Parameter	Type	Description
fileName	SalString	The destination report file path; its extension also selects the reporting engine when no type override is configured.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
defaultReport	SalBoolean	Reserved for compatibility; this argument is ignored.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalBoolean. True when the engine returns error code zero; false if a report cannot be created.

The optional template initializes the engine report. Overloads without a template pass an empty template name.

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

Creates a report file from the supplied variable and input definitions.

Parameter	Type	Description
fileName	SalString	The destination report file path; its extension also selects the reporting engine when no type override is configured.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
defaultReport	SalBoolean	Reserved for compatibility; this argument is ignored.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.
template	SalString	The source report template path.

Returns: SalBoolean. True when the engine returns error code zero; false if a report cannot be created.

The optional template initializes the engine report. Overloads without a template pass an empty template name.

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

Sets the report progress caption, two-line status text, and print document name.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
caption	SalString	The progress dialog caption.
line1	SalString	The first progress message line.
line2	SalString	The second progress message line.
docName	SalString	The document name used for printing.

Returns: SalBoolean. True if the report was found; otherwise, false.

ReportGetDateTimeVar(windowReport, variableName, value)

Reads a report variable and converts it to a SAL date/time.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalDateTime	Receives the report variable value when retrieval succeeds; remains unchanged when the report or variable is absent.

Returns: SalBoolean. True if the report and variable were found and conversion completed; otherwise, false.

ReportGetNumberVar(windowReport, variableName, value)

Reads a report variable and converts it to a SAL number.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalNumber	Receives the report variable value when retrieval succeeds; remains unchanged when the report or variable is absent.

Returns: SalBoolean. True if the report and variable were found and conversion completed; otherwise, false.

ReportGetObjectVar(windowReport, variableName, value)

Reads a report byte-array variable into a binary SAL string.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalString	Receives the report variable value when retrieval succeeds; remains unchanged when the report or variable is absent.

Returns: SalBoolean. True if a byte-array value was retrieved; otherwise, false.

A non-null variable of another type clears the output to SalString.Null and returns false.

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

Reads the printer, orientation, and paper settings of a report.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
printerName	SalString	Receives the current printer name.
orientation	SalNumber	Receives Sys.RPT_Landscape or Sys.RPT_Portrait.
paperType	SalNumber	Receives the paper kind, with custom paper represented by Sys.RPT_PaperCustom.
width	SalNumber	Receives the paper width in hundredths of an inch.
height	SalNumber	Receives the paper height in hundredths of an inch.

Returns: SalBoolean. True if the report was found and the outputs were assigned; otherwise, false.

Read settings after report initialization. Width and height are returned in hundredths of an inch, although ReportSetPrinterSettings accepts thousandths of an inch.

ReportGetStringVar(windowReport, variableName, value)

Reads a report variable and converts it to a SAL string.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalString	Receives the report variable value when retrieval succeeds; remains unchanged when the report or variable is absent.

Returns: SalBoolean. True if the report and variable were found and conversion completed; otherwise, false.

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

Creates and prints a report using the selected reporting engine.

Parameter	Type	Description
owner	Control	The application control that owns the report and handles report messages.
template	SalString	The source report template path.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
copies	SalNumber	The requested number of printed copies.
options	SalNumber	The Sys.RPT_Print* flags passed to the reporting engine.
firstPage	SalNumber	The first page of the requested print or export range.
lastPage	SalNumber	The last page of the requested print or export range.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalWindowHandle. Always a null handle. Inspect the error output to determine the printing or export result.

The owner receives the report data and lifecycle messages supported by the engine.

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

Creates and exports a report to a file.

Parameter	Type	Description
owner	Control	The application control that owns the report and handles report messages.
template	SalString	The source report template path.
destFile	SalString	The destination path whose extension selects the export format.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
copies	SalNumber	Reserved for compatibility; this argument is ignored.
options	SalNumber	The Sys.RPT_Print* flags passed to the reporting engine.
firstPage	SalNumber	The first page of the requested print or export range.
lastPage	SalNumber	The last page of the requested print or export range.
rtfFormat	SalBoolean	Reserved for compatibility; this argument is ignored.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalWindowHandle. Always a null handle. Inspect the error output to determine the printing or export result.

The destination extension determines the export format; supported formats depend on the reporting engine.

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

Creates and exports a report to a file.

Parameter	Type	Description
owner	Control	The application control that owns the report and handles report messages.
template	SalString	The source report template path.
destFile	SalString	The destination path whose extension selects the export format.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
options	SalNumber	The Sys.RPT_Print* flags passed to the reporting engine.
firstPage	SalNumber	The first page of the requested print or export range.
lastPage	SalNumber	The last page of the requested print or export range.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalWindowHandle. Always a null handle. Inspect the error output to determine the printing or export result.

The destination extension determines the export format; supported formats depend on the reporting engine.

ReportReset(windowReport)

Resets the report through its reporting engine.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.

Returns: SalBoolean. True if the report was found and reset was requested; otherwise, false.

ReportSetDateTimeVar(windowReport, variableName, value)

Assigns a SAL date/time to a report variable.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalDateTime	The value to assign to the report variable.

Returns: SalBoolean. The reporting engine's assignment result, or false if no report was found.

ReportSetNumberVar(windowReport, variableName, value)

Assigns a SAL number to a report variable.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalNumber	The value to assign to the report variable.

Returns: SalBoolean. The reporting engine's assignment result, or false if no report was found.

ReportSetObjectVar(windowReport, variableName, value)

Assigns the binary contents of a SAL string to a report variable.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalString	The value to assign to the report variable.

Returns: SalBoolean. The reporting engine's assignment result, or false if no report was found.

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

Changes the printer, orientation, and paper settings of a report.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
printerName	SalString	The printer name, or an empty value to retain the current printer.
orientation	SalNumber	Sys.RPT_Landscape for landscape; any other value selects portrait.
paperType	SalNumber	The paper kind; values greater than zero update the paper size using the low byte of this value.
width	SalNumber	The custom paper width in thousandths of an inch; ignored for predefined paper kinds.
height	SalNumber	The custom paper height in thousandths of an inch; ignored for predefined paper kinds.

Returns: SalBoolean. True if the report was found and the resulting printer is valid; otherwise, false.

Apply settings while processing SAM_ReportStart. If the resulting printer is invalid, the previous nonempty printer name is restored; other changes are not rolled back.

ReportSetStringVar(windowReport, variableName, value)

Assigns a SAL string to a report variable.

Parameter	Type	Description
windowReport	SalWindowHandle	The report or preview window handle.
variableName	SalString	The name of the report variable.
value	SalString	The value to assign to the report variable.

Returns: SalBoolean. The reporting engine's assignment result, or false if no report was found.

ReportTableCreate(fileName, table, error)

Creates a report file using a table window as the data source.

Parameter	Type	Description
fileName	SalString	The destination report file path; its extension also selects the reporting engine when no type override is configured.
table	Control	The table control used as the report data source.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalBoolean. True when the engine creates the report successfully; otherwise, false.

The document name comes from the table's top-level control title, falling back to the output filename.

ReportTableCreate(fileName, table, error, template)

Creates a report file using a table window as the data source.

Parameter	Type	Description
fileName	SalString	The destination report file path; its extension also selects the reporting engine when no type override is configured.
table	Control	The table control used as the report data source.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.
template	SalString	The source report template path.

Returns: SalBoolean. True when the engine creates the report successfully; otherwise, false.

The document name comes from the table's top-level control title, falling back to the output filename.

ReportTablePrint(table, template, paramArray, error)

Creates and prints a report whose data source is a table window.

Parameter	Type	Description
table	Control	The table control used as the report data source.
template	SalString	The source report template path.
paramArray	SalArray<SalNumber>	Print settings indexed by Sys.RPT_PrintParamCopies, RPT_PrintParamFirstPage, RPT_PrintParamLastPage, and RPT_PrintParamOptions.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalWindowHandle. Always a null handle. Inspect the error output to determine the printing or export result.

ReportTableView(table, parent, template, error)

Creates a preview whose report data source is a table window.

Parameter	Type	Description
table	Control	The table control used as the report data source.
parent	Control	The control in which to display the preview, or null for an engine-created preview window.
template	SalString	The source report template path.
error	SalNumber	Receives zero after engine success or the engine error code after failure. An initial value of 1 requests a missing-file warning during report creation; some early failures leave this value unchanged.

Returns: SalWindowHandle. The preview container handle, or a null handle if the table is invalid or report creation or preview fails.

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

Creates a report preview in the requested parent control.

Parameter	Type	Description
owner	Control	The application control that owns the report and handles report messages.
parent	Control	The control in which to display the preview, or null for an engine-created preview window.
template	SalString	The source report template path.
variableNames	SalString	The comma-separated application variable expressions supplying report data.
inputs	SalString	The corresponding comma-separated report input names, with matching order and data types.
flags	SalNumber	On entry, the engine preview options. Receives zero after success or the engine error code; some early failures leave it unchanged. An initial value of 1 also requests a missing-file warning.

Returns: SalWindowHandle. The preview container handle, or a null handle if report creation or preview fails.

ResolveType(asm, typeName)

Resolves a type name using the supplied assembly and loaded runtime types.

Parameter	Type	Description
asm	Assembly	The assembly to search first for a qualified name, or null.
typeName	String	The non-null type name.

Returns: Type. The resolved Type, or null if lookup fails.

For names containing a period, tries the supplied assembly and Type.GetType before TypeManager. TypeLoadException is logged and converted to null.

SalRegexMatch(strInput, strRegex, matches)

Collects regular-expression matches in a dynamic SAL array.

Parameter	Type	Description
strInput	SalString	The input text; null is treated as empty.
strRegex	SalString	The regular-expression pattern.
matches	SalArray<SalString>	The non-null array to make dynamic, clear, and populate from index zero.

Returns: SalNumber. The number of matches, or zero for an empty pattern or caught matching error.

SalRegexReplace(strInput, strRegex, strReplacement, result)

Replaces every regular-expression match in the input.

Parameter	Type	Description
strInput	SalString	The input text; null is treated as empty.
strRegex	SalString	The regular-expression pattern.
strReplacement	SalString	The .NET replacement expression; null is treated as empty.
result	SalString	Receives the resulting text.

Returns: SalString. The same text assigned to result.

An empty pattern or caught exception returns the original input.

SalRegexSearch(strInput, nStart, strRegex, nMatchStart, nMatchLength, match)

Searches for the first regular-expression match in a suffix of the input.

Parameter	Type	Description
strInput	SalString	The input text; null is treated as empty.
nStart	SalNumber	The one-based start position; values below one become one.
strRegex	SalString	The regular-expression pattern.
nMatchStart	SalNumber	Receives the one-based start of a match, or zero.
nMatchLength	SalNumber	Receives the match length, or zero.
match	SalString	Receives the matched text, or SalString.Null.

Returns: SalNumber. One if a match is found; otherwise, zero.

Matching is performed against the substring beginning at the requested position, so anchors refer to that substring. Errors return zero.

ScrollGetPos(ctrl, pos)

Retrieves the position of the associated scrolling control.

Parameter	Type	Description
ctrl	Control	The target control.
pos	SalNumber	Receives the current position, or zero for a control of a different type.

Returns: SalBoolean. False for an unavailable control; otherwise, true.

Uses a Windows Forms ScrollBar.

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

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

Returns: SalBoolean.

ScrollSetPos(ctrl, pos)

Parameter	Type	Description
ctrl	Control
pos	SalNumber

Returns: SalBoolean.

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

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

Returns: SalBoolean.

SendClassMessage(message, wParam, lParam)

Invokes the next class-level message handler for the current SAL context.

Parameter	Type	Description
message	SalNumber	The message identifier.
wParam	SalNumber	The message's wParam.
lParam	SalNumber	The message's lParam.

Returns: SalNumber. The result from SalWindow.SendClassMessage.

Uses the active window-actions index when available; otherwise begins with the calling method's declaring type.

SendClassMessageNamed(type, message, wParam, lParam)

Dispatches a class message beginning at a specified type.

Parameter	Type	Description
type	Type	The class at which handler lookup begins.
message	SalNumber	The message identifier.
wParam	SalNumber	The message's wParam.
lParam	SalNumber	The message's lParam.

Returns: SalNumber. The result from SalWindow.SendClassMessageNamed.

SendMsg(ctrl, message, wParam, lParam)

Parameter	Type	Description
ctrl	Control
message	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalNumber.

Example:

Dispatch a custom action immediately and read the value returned by its handler.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public class MessageWindow : SalFormWindow
{
    private const int QueryCount = Sys.SAM_User + 1;

    public MessageWindow()
    {
        WindowActions += (sender, e) =>
        {
            if (e.ActionType == QueryCount)
            {
                e.Return = 42;
            }
        };
    }

    public SalNumber ReadCount()
    {
        // Call on a live window from the UI thread.
        return Sal.SendMsg(this, QueryCount, 0, 0);
    }
}

SendMsgToChildren(ctrl, message, wParam, lParam)

Parameter	Type	Description
ctrl	Control
message	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

SendValidateMsg()

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.

SetButtonChecked(ctrl, value)

Parameter	Type	Description
ctrl	Control
value	SalNumber

Returns: SalBoolean.

SetDefButton(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

SetErrorInfo(code, desc, helpfileName, helpContext)

Throws a COMException containing SAL error information.

Parameter	Type	Description
code	SalNumber	The HRESULT, converted to a 32-bit integer.
desc	SalString	The exception message.
helpfileName	SalString	The help file or URL.
helpContext	SalNumber	The help context appended as a fragment identifier.

Returns: SalBoolean. This method does not return.

SetFieldEdit(ctrl, set)

Parameter	Type	Description
ctrl	Control
set	SalBoolean

Returns: SalBoolean.

SetFocus(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalWindowHandle.

SetHintText(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString

Returns: SalBoolean.

SetMaxDataLength(ctrl, length)

Parameter	Type	Description
ctrl	Control
length	SalNumber

Returns: SalBoolean.

SetProfileString(section, entry, value, fileName)

Parameter	Type	Description
section	SalString
entry	SalString
value	SalString
fileName	SalString

Returns: SalBoolean.

SetWindowLabelText(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString

Returns: SalBoolean.

SetWindowLoc(ctrl, x, y)

Sets a control's location in form units.

Parameter	Type	Description
ctrl	Control	The target control.
x	SalNumber	The horizontal coordinate.
y	SalNumber	The vertical coordinate.

Returns: SalBoolean. The result of SalWindow.SetLocation.

SetWindowSize(ctrl, width, height)

Sets a control's size in form units.

Parameter	Type	Description
ctrl	Control	The target control.
width	SalNumber	The requested width.
height	SalNumber	The requested height.

Returns: SalBoolean. The result of SalWindow.SetSize.

SetWindowText(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString

Returns: SalBoolean.

ShowWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

ShowWindowAndLabel(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

StartTrace(outputType, traceFile, clearExisting)

Parameter	Type	Description
outputType	SalNumber
traceFile	SalString
clearExisting	SalBoolean

Returns: SalBoolean.

StaticFirst(form)

Finds the first static child control.

Parameter	Type	Description
form	Control	The parent to search.

Returns: SalNumber. The numeric handle of the first label, group box, frame, or line; zero if none is found.

StaticGetLabel(ctrl)

Finds the label associated with a control.

Parameter	Type	Description
ctrl	Control	The target control.

Returns: SalNumber. The label's numeric handle, or zero if none is found.

StaticGetLoc(form, handle, x, y)

Reads a static control's location in pixels.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.
x	SalNumber	Receives the horizontal position in pixels.
y	SalNumber	Receives the vertical position in pixels.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StaticGetSize(form, handle, width, height)

Reads a static control's size in pixels.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.
width	SalNumber	Receives the width in pixels.
height	SalNumber	Receives the height in pixels.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StaticHide(form, handle)

Hides a static control.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StaticIsVisible(form, handle)

Tests whether a static control is visible.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.

Returns: SalBoolean. True if the control exists and is visible; otherwise, false.

StaticNext(form, handle)

Finds the next static sibling control.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The current control's numeric handle.

Returns: SalNumber. The next label, group box, frame, or line handle; zero if the current or next control is unavailable.

StaticSetLoc(form, handle, x, y)

Sets a static control's location in pixels.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.
x	SalNumber	The horizontal position in pixels.
y	SalNumber	The vertical position in pixels.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StaticSetSize(form, handle, width, height)

Sets a static control's size in pixels.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.
width	SalNumber	The width in pixels.
height	SalNumber	The height in pixels.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StaticShow(form, handle)

Shows a static control.

Parameter	Type	Description
form	Control	Ignored; the numeric control handle is used.
handle	SalNumber	The numeric control handle.

Returns: SalBoolean. True if the control is resolved and the operation completes; otherwise, false.

StatusGetText(ctrl, text, maxLen)

Reads the owning form's status-bar text.

Parameter	Type	Description
ctrl	Control	The target control.
text	SalString	Receives the truncated status text, or an empty string if no status bar is found.
maxLen	SalNumber	The maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

StatusSetText(ctrl, text)

Parameter	Type	Description
ctrl	Control
text	SalString

Returns: SalBoolean.

StatusSetVisible(ctrl, show)

Parameter	Type	Description
ctrl	Control
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)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalNumber.

StrIsValidCurrency(money, precision, scale)

Parameter	Type	Description
money	SalString	The SalString value on which to perform the operation.
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

StrIsValidDateTime(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalBoolean.

StrIsValidDecimal(str, precision, scale)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.
precision	SalNumber
scale	SalNumber

Returns: SalBoolean.

StrIsValidIdentifierName(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalBoolean.

StrIsValidNumber(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalBoolean.

StrLeft(source, length, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
length	SalNumber
target	SalString

Returns: SalNumber.

StrLeftX(source, length)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
length	SalNumber

Returns: SalString.

StrLength(str)

Returns the length of a SAL string.

Parameter	Type	Description
str	SalString	The string to measure.

Returns: SalNumber. The string's Length value.

StrLop(str)

Parameter	Type	Description
str	SalString

Returns: SalNumber.

StrLower(source, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
target	SalString

Returns: SalNumber.

StrLowerX(source)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.

Returns: SalString.

StrMid(source, startPos, length, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
startPos	SalNumber
length	SalNumber
target	SalString

Returns: SalNumber.

StrMidX(source, startPos, length)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
startPos	SalNumber
length	SalNumber

Returns: SalString.

StrProper(source, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
target	SalString

Returns: SalNumber.

StrProperX(source)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.

Returns: SalString.

StrRepeat(source, times, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
times	SalNumber
target	SalString

Returns: SalNumber.

StrRepeatX(source, times)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
times	SalNumber

Returns: SalString.

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

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
startPos	SalNumber
length	SalNumber
replace	SalString
target	SalString

Returns: SalNumber.

StrReplaceX(source, startPos, length, replace)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
startPos	SalNumber
length	SalNumber
replace	SalString

Returns: SalString.

StrRight(source, length, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
length	SalNumber
target	SalString

Returns: SalNumber.

StrRightX(source, length)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
length	SalNumber

Returns: SalString.

StrScan(str1, str2)

Parameter	Type	Description
str1	SalString	The SalString value on which to perform the operation.
str2	SalString

Returns: SalNumber.

StrSetBufferLength(str, length)

Parameter	Type	Description
str	SalString
length	SalNumber

Returns: SalBoolean.

StrToDate(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalDateTime.

StrTokenize(source, startDel, endDel, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
startDel	SalString
endDel	SalString
target	SalArray<SalString>

Returns: SalNumber.

StrToNumber(str)

Parameter	Type	Description
str	SalString	The SalString value on which to perform the operation.

Returns: SalNumber.

StrTrim(source, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
target	SalString

Returns: SalNumber.

StrTrimX(source)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.

Returns: SalString.

StrUncompress(str)

Parameter	Type	Description
str	SalString

Returns: SalBoolean.

StrUpper(source, target)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.
target	SalString

Returns: SalNumber.

StrUpperX(source)

Parameter	Type	Description
source	SalString	The SalString value on which to perform the operation.

Returns: SalString.

TabAddPage(control, pageIndex, pageName)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
pageName	SalString
imageFile	SalString
tooltip	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabAssociateChild(control, pageIndex, child)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
child	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabAttachWindow(control, pageIndex, form)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
form	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabDetachWindow(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalWindowHandle. For an incompatible control, SalWindowHandle.Null; otherwise,

TabDisablePage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabDisassociateChild(control, pageIndex, child)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
child	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabEnablePage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabGetActivePage(control)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.

Returns: SalNumber. For an incompatible control, -1; otherwise,

TabGetPageIndex(control, pageName)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageName	SalString

Returns: SalNumber. For an incompatible control, SalBoolean.False; otherwise,

TabGetPageName(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalString. For an incompatible control, SalString.Null; otherwise,

TabGetPageTitle(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalString. For an incompatible control, SalString.Null; otherwise,

TabGetPageWindow(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalWindowHandle. For an incompatible control, SalWindowHandle.Null; otherwise,

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
tooltip	SalString
maxLength	SalNumber

Returns: SalNumber. For an incompatible control, -1; otherwise,

TabHidePage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabHideStrip(control)

Retains the TabHideStrip operation as a compatibility stub.

Parameter	Type	Description
control	Control	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

TabPageCount(control)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.

Returns: SalNumber. For an incompatible control, 0; otherwise,

TabRemovePage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabRenamePage(control, pageIndex, pageName)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabSetActivePage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabSetPageTitle(control, pageIndex, pageTitle)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
pageTitle	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber
tooltip	SalString

Returns: SalBoolean. For an incompatible control, -1; otherwise,

TabShowPage(control, pageIndex)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.
pageIndex	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TabShowStrip(control)

Retains the TabShowStrip operation as a compatibility stub.

Parameter	Type	Description
control	Control	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

TabUpdate(control)

Parameter	Type	Description
control	Control	The control resolved as SalQuickTabs value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TBarSetVisible(ctrl, show)

Parameter	Type	Description
ctrl	Control
show	SalBoolean

Returns: SalBoolean.

TblAnyRows(table, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblClearSelection(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblColumnAverage(table, columnId, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columnId	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblColumnSum(table, columnId, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columnId	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblCopyRows(table, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

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

Creates a string column in a table window.

Parameter	Type	Description
table	Control	The table control.
columnPos	SalNumber	The column insertion position.
displayWidth	SalNumber	The display width in form units.
maxChars	SalNumber	The maximum text length.
title	SalString	The column title.

Returns: SalNumber. The CreateColumn result, or zero when the control is not a table window.

TblCreateColumnEx(table, columnPos, displayWidth, title, maxChars, dataType)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columnPos	SalNumber
displayWidth	SalNumber
title	SalString
maxChars	SalNumber
dataType	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblCreateColumnFromClass(table, className, position)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
className	SalString
position	SalNumber

Returns: SalWindowHandle. For an incompatible control, SalWindowHandle.Null; otherwise,

TblDefineCheckBoxColumn(column, flags, checkedValue, uncheckedValue)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
checkedValue	SalString
uncheckedValue	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDefineDropDownListColumn(column, flags, lines)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
lines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDefinePopupEditColumn(column, flags, lines)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
lines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

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

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
title	SalString
width	SalNumber
flags	SalNumber
column	Control

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDefineSplitWindow(table, rowsLowerHalf, dragAdjust)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
rowsLowerHalf	SalNumber
dragAdjust	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDeleteRow(table, row, flag)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
flag	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDeleteSelected(table, sql)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDeleteSelected(table, sql, errorHandler)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDestroyColumns(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoDeletes(table, sql, flagsOn)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
flagsOn	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoDeletes(table, sql, flagsOn, errorHandler)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
flagsOn	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoInserts(table, sql, clearFlags)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoInserts(table, sql, clearFlags, errorHandler)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoUpdates(ctrl, sql, clearFlags)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblDoUpdates(table, sql, clearFlags, errorHandler)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblFetchRow(table, row)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber

Returns: SalNumber. For an incompatible control, Sys.TBL_NoMoreRows; otherwise,

TblFindNextRow(table, row, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblFindPrevRow(table, row, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblGetColumnText(table, columnId, text)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columnId	SalNumber
text	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblGetColumnTitle(column, text, maxLen)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
text	SalString
maxLen	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblGetColumnWindow(table, col, flags)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
col	SalNumber
flags	SalNumber

Returns: SalWindowHandle. For an incompatible control, SalWindowHandle.Null; otherwise,

TblInsertRow(table, row)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblKillEdit(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblKillFocus(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

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

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
x	SalNumber
y	SalNumber
row	SalNumber
column	SalWindowHandle
flags	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblPasteRows(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblPopulate(table, sql, select, method)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
select	SalString
method	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

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

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
sql	SalSqlHandle
select	SalString
method	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblPopulateFromXML(table, file, rootNode, tableNode, useSchema)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
file	SalString
rootNode	SalString
tableNode	SalBoolean
useSchema	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryCheckBoxColumn(column, flags, checkedValue, uncheckedValue)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
checkedValue	SalString
uncheckedValue	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryColumnCellType(column, type)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
type	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryColumnFlags(column, flags)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryColumnID(column)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.

Returns: SalNumber. For an incompatible control, SalNumber.MinusOne; otherwise,

TblQueryColumnPos(column)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.

Returns: SalNumber. For an incompatible control, SalNumber.MinusOne; otherwise,

TblQueryColumnWidth(column, width)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
width	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryContext(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

Example:

Save and restore the row context while updating a column in another row.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public static class RowExample
{
    public static bool SetStatus(SalTableWindow table,
        SalNumber row, SalNumber statusColumnId)
    {
        SalNumber saved = Sal.TblQueryContext(table);
        try
        {
            if (!Sal.TblSetContext(table, row))
                return false;
            return table.SetColumnText(statusColumnId, "Reviewed");
        }
        finally
        {
            // The original row must still exist when it is restored.
            Sal.TblSetContext(table, saved);
        }
    }
}

TblQueryDropDownListColumn(column, flags, lines)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
lines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryFocus(table, row, column)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
column	SalWindowHandle

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryLinesPerRow(table, nLines)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
nLines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryLockedColumns(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TblQueryPopupEditColumn(column, flags, lines)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
lines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryRowFlags(table, row, flags)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
flags	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

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

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
title	SalString
maxTitle	SalNumber
width	SalNumber
flags	SalNumber
windowCol	SalWindowHandle

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryScroll(table, position, minRange, maxRange)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
position	SalNumber
minRange	SalNumber
maxRange	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQuerySplitWindow(table, rowsLowerHalf, dragAdjust)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
rowsLowerHalf	SalNumber
dragAdjust	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryTableFlags(table, flags)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
flags	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblQueryVisibleRange(table, minRange, maxRange)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
minRange	SalNumber
maxRange	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblReset(table)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblScroll(table, row, column, flags)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
column	Control
flags	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblScroll(table, row, column)

Scrolls a table to make a row and column visible.

Parameter	Type	Description
table	Control	The table control.
row	SalNumber	The row to reveal.
column	Control	The column to reveal.

Returns: SalBoolean. The four-argument TblScroll result with options set to zero.

TblSetCellTextColor(column, colorValue, discardable)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
colorValue	SalNumber
discardable	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetCellTextColor(column, colorValue)

Sets a table cell's text color without marking the value discardable.

Parameter	Type	Description
column	Control	The table column for the current context row.
colorValue	SalNumber	The SAL color value.

Returns: SalBoolean. The three-argument TblSetCellTextColor result with discardable set to false.

TblSetColumnFlags(column, flags, set)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
flags	SalNumber
set	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetColumnPos(column, pos)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
pos	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetColumnText(table, columndId, text)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columndId	SalNumber
text	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetColumnTitle(column, title)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
title	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetColumnWidth(column, width)

Parameter	Type	Description
column	Control	The control resolved as SalTableColumn value on which to perform the operation.
width	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetContext(table, nRow)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
nRow	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

Example:

Save and restore the row context while updating a column in another row.

using PPJ.Runtime;
using PPJ.Runtime.Windows;
using System.Windows.Forms;

public static class RowExample
{
    public static bool SetStatus(SalTableWindow table,
        SalNumber row, SalNumber statusColumnId)
    {
        SalNumber saved = Sal.TblQueryContext(table);
        try
        {
            if (!Sal.TblSetContext(table, row))
                return false;
            return table.SetColumnText(statusColumnId, "Reviewed");
        }
        finally
        {
            // The original row must still exist when it is restored.
            Sal.TblSetContext(table, saved);
        }
    }
}

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

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
flags	SalNumber
set	SalBoolean
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetFocusCell(table, row, column, editMin, editMax)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
column	Control
editMin	SalNumber
editMax	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetFocusRow(table, row)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetLinesPerRow(table, lines)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
lines	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetLockedColumns(table, lockedColumns)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
lockedColumns	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetRange(table, min, max)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
min	SalNumber
max	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetRow(table, rowPosition)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
rowPosition	SalNumber

Returns: SalNumber. For an incompatible control, Sys.TBL_Error; otherwise,

TblSetRowFlags(table, row, flags, set)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
row	SalNumber
flags	SalNumber
set	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSetTableFlags(table, flags, set)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
flags	SalNumber
set	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblSortRows(table, columnId, order)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
columnId	SalNumber
order	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblWriteXMLandSchema(table, path, writeTypes)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
path	SalString
writeTypes	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TblWriteXMLandSchemaEx(table, path, writeTypes, flagsOn, flagsOff)

Parameter	Type	Description
table	Control	The control resolved as SalTableWindow value on which to perform the operation.
path	SalString
writeTypes	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.False; otherwise,

TimerKill(ctrl, eventId)

Parameter	Type	Description
ctrl	Control
eventId	SalNumber

Returns: SalBoolean.

TimerSet(ctrl, eventId, milliseconds)

Parameter	Type	Description
ctrl	Control
eventId	SalNumber
milliseconds	SalNumber

Returns: SalBoolean.

Trace(severity, textToWrite)

Parameter	Type	Description
severity	SalNumber
textToWrite	SalString

Returns: SalBoolean.

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

Creates and displays a popup menu.

Parameter	Type	Description
owner	Control	The popup owner.
menuName	SalString	The menu type name to resolve.
flags	SalNumber	TPM_ positioning and interaction flags supported by the runtime.
x	SalNumber	The horizontal screen coordinate in pixels, unless TPM_CursorX is set.
y	SalNumber	The vertical screen coordinate in pixels, unless TPM_CursorY is set.

Returns: SalBoolean. True if the popup is created and displayed; otherwise, false.

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

Creates and displays a popup menu.

Parameter	Type	Description
owner	Control	The popup owner.
menuType	Type	The menu type to instantiate.
flags	SalNumber	TPM_ positioning and interaction flags supported by the runtime.
x	SalNumber	The horizontal screen coordinate in pixels, unless TPM_CursorX is set.
y	SalNumber	The vertical screen coordinate in pixels, unless TPM_CursorY is set.

Returns: SalBoolean. True if the popup is created and displayed; otherwise, false.

TreeCollapseItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeDeleteItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeDemoteItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeEditItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeEnableItem(ctrl, hItem, enable)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
enable	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeExpandItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeFindItemByData(ctrl, hItem, data)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
data	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeFindItemByTitle(ctrl, hItem, title)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
title	SalString

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetFirstItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetItemCount(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetItemData(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetItemParent(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetItemText(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalString. For an incompatible control, SalString.Null; otherwise,

TreeGetItemTooltip(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalString. For an incompatible control, SalString.Null; otherwise,

TreeGetNextItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetPrevItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeGetSelectedItem(ctrl)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeInsertItem(ctrl, hItem, index, title)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
index	SalNumber
title	SalString

Returns: SalNumber. For an incompatible control, SalNumber.Zero; otherwise,

TreeItemHasCheckBox(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeItemIsChecked(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeItemIsExpanded(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeItemIsSelected(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeItemsHaveCheckBoxes(ctrl)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeMoveDownItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeMoveItem(ctrl, hItem, parentItem, position)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
parentItem	SalNumber
position	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeMoveUpItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreePromoteItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeReset(ctrl, remove)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
remove	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemChecked(ctrl, hItem, bChecked)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
bChecked	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemData(ctrl, hItem, value)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
value	SalNumber

Returns: SalNumber. For an incompatible control, SalNumber.Null; otherwise,

TreeSetItemEditable(ctrl, hItem, editable)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
editable	SalBoolean

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemFontEnh(ctrl, hItem, fontEnh)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
fontEnh	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemImage(ctrl, hItem, selected, imageFile)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
selected	SalBoolean
imageFile	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemImageFromBinary(ctrl, hItem, selected, format, picture)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
selected	SalBoolean
format	SalNumber
picture	SalBinary

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemImageFromResource(ctrl, hItem, selected, resource)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
selected	SalBoolean
resource	SalResource

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemText(ctrl, hItem, text)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
text	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetItemTextColor(ctrl, hItem, color)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
color	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
tooltip	SalString

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeSetSelectedItem(ctrl, hItem)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber

Returns: SalBoolean. For an incompatible control, SalBoolean.Null; otherwise,

TreeShowItemCheckBox(ctrl, hItem, show)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
hItem	SalNumber
show	SalBoolean

Returns: SalBoolean. For an incompatible control, SalNumber.Zero; otherwise,

TreeShowItemsCheckBoxes(ctrl, show)

Parameter	Type	Description
ctrl	Control	The control resolved as SalTreeControl value on which to perform the operation.
show	SalBoolean

Returns: SalBoolean. For an incompatible control, SalNumber.Zero; otherwise,

UpdateWindow(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalBoolean.

UseEventLog(useLog, resume)

Parameter	Type	Description
useLog	SalBoolean
resume	SalBoolean

Returns: SalBoolean.

UseRegistry(useRegistry, companyName)

Parameter	Type	Description
useRegistry	SalBoolean
companyName	SalString

Returns: SalBoolean.

ValidateSet(window, state, lParam)

Deprecated: Not supported. Retains the ValidateSet operation as a compatibility stub.

Parameter	Type	Description
window	SalWindowHandle	Ignored; no operation is performed.
state	SalBoolean	Ignored; no operation is performed.
lParam	SalNumber	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

WaitCursor(on)

Parameter	Type	Description
on	SalBoolean

Returns: SalBoolean.

WindowClassName(ctrl)

Parameter	Type	Description
ctrl	Control

Returns: SalString.

WindowGetDockSetting(window, orientation)

Retains the WindowGetDockSetting operation as a compatibility stub.

Parameter	Type	Description
window	SalWindowHandle	Ignored; no operation is performed.
orientation	SalNumber	Ignored; no operation is performed.

Returns: SalBoolean. False.

Reference arguments, if any, are left unchanged.

WindowGetProperty(ctrl, name, value)

Parameter	Type	Description
ctrl	Control
name	SalString
value	SalString

Returns: SalBoolean.

WindowHandleToNumber(window)

Parameter	Type	Description
window	SalWindowHandle	The SalWindowHandle value on which to perform the operation.

Returns: SalNumber.

WindowHandleToNumber(file)

Returns a runtime handle identifier as a SAL number.

Parameter	Type	Description
file	SalFileHandle	The handle whose identifier is read.

Returns: SalNumber. The numeric Handle value.

WindowHandleToNumber(sql)

Returns a runtime handle identifier as a SAL number.

Parameter	Type	Description
sql	SalSqlHandle	The handle whose identifier is read.

Returns: SalNumber. The numeric Handle value.

WindowHandleToNumber(session)

Returns a runtime handle identifier as a SAL number.

Parameter	Type	Description
session	SalSqlSessionHandle	The handle whose identifier is read.

Returns: SalNumber. The numeric Handle value.

WindowIsDerivedFromClass(ctrl, type)

Parameter	Type	Description
ctrl	Control
type	Type

Returns: SalBoolean.

WindowSetProperty(ctrl, name, value, length)

Stores a named SAL string property after truncating its value.

Parameter	Type	Description
ctrl	Control	The target control.
name	SalString	The property name.
value	SalString	The value to store.
length	SalNumber	The maximum number of characters to retain.

Returns: SalBoolean. The result of SalWindow.SetProperty.

WinHelp(ctrl, file, command, index, key)

Parameter	Type	Description
ctrl	Control
file	SalString
command	SalNumber
index	SalNumber
key	SalString

Returns: SalBoolean.

XMLDeserialize<T>(obj, filePath)

Attempts to deserialize a value from an XML file.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	Receives the deserialized value on success; unchanged on failure.
filePath	SalString	The source XML file path.

Returns: SalBoolean. True, including when deserialization fails.

Clears the previous XML error first. Errors are logged and retained for XMLGetLastError.

XMLDeserialize<T>(xml)

Deserializes a value from XML encoded as UTF-16.

Parameter	Type	Description
T		The type to deserialize.
xml	SalString	The XML text.

Returns: T. The deserialized value, or default(T) on an exception.

Errors are logged and retained for XMLGetLastError.

XMLGetLastError(errorCode, errorMessage)

Retrieves the exception recorded by the most recent XML operation.

Parameter	Type	Description
errorCode	SalNumber	Receives the HRESULT, or zero when no exception was recorded.
errorMessage	SalString	Receives the exception message, or an empty string when no exception was recorded.

Returns: SalBoolean. True if an exception was recorded; otherwise, false.

XMLSerialize<T>(obj, filePath)

Attempts to serialize a value to an XML file.

Parameter	Type	Description
T		The type of the value to serialize or deserialize.
obj	T	The value to serialize.
filePath	SalString	The destination file path.

Returns: SalBoolean. True, including when serialization fails.

Clears the previous XML error before attempting the operation. Errors are logged and retained for XMLGetLastError.

XMLSerialize<T>(obj)

Serializes a value and decodes the backing memory buffer as UTF-16.

Parameter	Type	Description
T		The type to serialize.
obj	T	The value to serialize.

Returns: SalString. The decoded backing buffer, or SalString.Null on an exception.

The entire buffer capacity is decoded, so unused trailing bytes can appear as null characters. Errors are logged and retained for XMLGetLastError.

Yield(ctrl)

Allows pending window messages to be processed.

Parameter	Type	Description
ctrl	Control	The control whose current SAL context is preserved.

YieldEnable(set)

Deprecated: Use Sal.Yield(window). Retains the YieldEnable operation as a compatibility stub.

Parameter	Type	Description
set	SalBoolean	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

YieldQueryState()

Deprecated: Use Sal.Yield(window). Retains the YieldQueryState operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

YieldStartMessages(window)

Deprecated: Use Sal.Yield(window). Retains the YieldStartMessages operation as a compatibility stub.

Parameter	Type	Description
window	SalWindowHandle	Ignored; no operation is performed.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

YieldStopMessages()

Deprecated: Use Sal.Yield(window). Retains the YieldStopMessages operation as a compatibility stub.

Returns: SalBoolean. False.

Logs the unsupported call. Reference arguments are left unchanged.

Properties
- Interpreter
- SalReportType
Methods

Properties​

Interpreter​

SalReportType​

Methods​

Abort(exitCode)​

ActiveXAutoErrorMode(on)​

ActiveXDoVerb(ctrl, verb, size)​

ActiveXGetObject(ctrl, obj)​

AppDisable()​

AppEnable()​

AppFind(name, activate)​

ArrayAvg(array)​

ArrayDimCount(array, dim)​

ArrayGetLowerBound(array, dim, bound)​

ArrayGetUpperBound(array, dim, bound)​

ArrayIsEmpty(array)​

ArrayMax(array)​

ArrayMin(array)​

ArrayQueryBounds(array, min, max)​

ArraySetBounds(array, lower, upper)​

ArraySetUpperBound(array, dim, bound)​

ArraySum(array)​

BringWindowToTop(ctrl)​

CenterWindow(ctrl)​

ClearField(ctrl)​

ColorFromRGB(red, green, blue)​

ColorGet(ctrl, colorIndex)​

ColorGetSysColor(colorIndex)​

ColorSet(ctrl, colorIndex, colorValue)​

ColorToRGB(colorValue, red, green, blue)​

ColorToRGB(color, red, green, blue)​

CompileAndEvaluate(expression, error, errorPos, numReturn, sReturn, dtReturn, windowReturn, inhibitErrors, context)​

ContextBreak()​

ContextCurrent(context)​

ContextMenuSetPopup(ctrl, menuName, flags)​

ContextMenuSetPopup(ctrl, menuType, flags)​

CreateWindow(wndToCreate, parent, parameters)​

CreateWindow(formName, parent, parameters)​

CreateWindow(formName, parent)​

CreateWindowEx(wndToCreate, parent, left, top, width, height, flags, parameters)​

CreateWindowEx(formName, parent, left, top, width, height, flags)​

CreateWindowExFromStr(formName, parent, left, top, width, height, flags)​

CreateWindowFromStr(formName, parent)​

CursorClear(ctrl, type)​

CursorSet(ctrl, resource, type)​

CursorSet(ctrl, resourceId, type)​

CursorSetFile(ctrl, fileName, type)​

CursorSetString(ctrl, blob, type)​

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

DateCurrent()​

DateDay(dateTime)​

DateHour(dateTime)​

DateMinute(dateTime)​

DateMonth(dateTime)​

DateMonthBegin(dateTime)​

DateQuarter(dateTime)​

DateQuarterBegin(dateTime)​

DateSecond(dateTime)​

DateToStr(date, target)​

DateWeekBegin(dateTime)​

DateWeekday(dateTime)​

DateYear(dateTime)​

DateYearBegin(dateTime)​

DestroyWindow(ctrl)​

DisableWindow(ctrl)​

DisableWindowAndLabel(ctrl)​

DlgChooseColor(ctrl, colorValue)​

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

DlgGetDockStatus(windowDlg, orientation)​

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

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

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

DlgSetDockStatus(windowDlg, orientation)​

DragDropDisableDrop()​

DragDropEnableDrop()​

DragDropGetSource(window, x, y)​

DragDropGetTarget(windowTarget, x, y)​

DragDropStart(ctrl)​

DragDropStop()​

DrawMenuBar(ctrl)​

Properties

Interpreter

SalReportType

Methods

Abort(exitCode)

ActiveXAutoErrorMode(on)

ActiveXDoVerb(ctrl, verb, size)

ActiveXGetObject(ctrl, obj)

AppDisable()

AppEnable()

AppFind(name, activate)

ArrayAvg(array)

ArrayDimCount(array, dim)

ArrayGetLowerBound(array, dim, bound)

ArrayGetUpperBound(array, dim, bound)

ArrayIsEmpty(array)

ArrayMax(array)

ArrayMin(array)

ArrayQueryBounds(array, min, max)

ArraySetBounds(array, lower, upper)

ArraySetUpperBound(array, dim, bound)

ArraySum(array)

BringWindowToTop(ctrl)

CenterWindow(ctrl)

ClearField(ctrl)

ColorFromRGB(red, green, blue)

ColorGet(ctrl, colorIndex)

ColorGetSysColor(colorIndex)

ColorSet(ctrl, colorIndex, colorValue)

ColorToRGB(colorValue, red, green, blue)

ColorToRGB(color, red, green, blue)

CompileAndEvaluate(expression, error, errorPos, numReturn, sReturn, dtReturn, windowReturn, inhibitErrors, context)

ContextBreak()

ContextCurrent(context)

ContextMenuSetPopup(ctrl, menuName, flags)

ContextMenuSetPopup(ctrl, menuType, flags)

CreateWindow(wndToCreate, parent, parameters)

CreateWindow(formName, parent, parameters)

CreateWindow(formName, parent)

CreateWindowEx(wndToCreate, parent, left, top, width, height, flags, parameters)

CreateWindowEx(formName, parent, left, top, width, height, flags)

CreateWindowExFromStr(formName, parent, left, top, width, height, flags)

CreateWindowFromStr(formName, parent)

CursorClear(ctrl, type)

CursorSet(ctrl, resource, type)

CursorSet(ctrl, resourceId, type)

CursorSetFile(ctrl, fileName, type)

CursorSetString(ctrl, blob, type)

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

DateCurrent()

DateDay(dateTime)

DateHour(dateTime)

DateMinute(dateTime)

DateMonth(dateTime)

DateMonthBegin(dateTime)

DateQuarter(dateTime)

DateQuarterBegin(dateTime)

DateSecond(dateTime)

DateToStr(date, target)

DateWeekBegin(dateTime)

DateWeekday(dateTime)

DateYear(dateTime)

DateYearBegin(dateTime)

DestroyWindow(ctrl)

DisableWindow(ctrl)

DisableWindowAndLabel(ctrl)

DlgChooseColor(ctrl, colorValue)

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

DlgGetDockStatus(windowDlg, orientation)

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

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

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

DlgSetDockStatus(windowDlg, orientation)

DragDropDisableDrop()

DragDropEnableDrop()

DragDropGetSource(window, x, y)

DragDropGetTarget(windowTarget, x, y)

DragDropStart(ctrl)

DragDropStop()

DrawMenuBar(ctrl)