Sys

PPJ.Runtime.Sys

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.49 (4.9.0.0)

Global class containing all the system variables and constants required by the migrated SAL application.

public class Sys

Fields

NameTypeDescription

AC_Dynamic

Specify this constant with Sal.ArraySetUpperBound to change a const array to a dynamic array.

CF_Text

This constant represents the format value returned by a call to Sal.DDEExtractOptions.

CM_TableCell

Specify this in Sal.ContextMenuSetPopup to replace the default menu that Windows displays when the mouse pointer is in an editable table window cell.

COL_CellType_CheckBox

check box column

COL_CellType_DropDownList

downstairs column

COL_CellType_PopupEdit

populated column

COL_CellType_Standard

standard column

COL_CenterJustify

This table column flag indicates that you want to center text in a table window column. If this flag is set, you cannot also set the COL_CenterJustify flag at the same time. If you set neither COL_RightJustify nor COL_CenterJustify, then it left-justifies the column text by default. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_CheckBox_IgnoreCase

Used on check box columns to indicate that it should ignore the case of the checked and unchecked strings.

COL_DimTitle

This table column flag indicates that a column title is show as disabled text. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_DropDownList_Auto

COL_DropDownList_Editable

COL_DropDownList_Sorted

COL_DropDownList_VScroll

COL_Editable

This table column flag lets users edit the text of a table window column. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_EnableSort

This grid column flag enables sorting in the context menu (right click on column header). Sorting is enabled when set to TRUE and disabled when set to FALSE. This also affects SalTblSortRows function (i.e. SalTblSortRows will have no effect if this flag is set to FALSE).

COL_GetID

This table column flag indicates that you want to get a column based on its identifier. Use this constant with the Sal.TblGetColumnWindow function. 1 is the first column in the application outline.

COL_GetPos

This table column flag indicates that you want to get a column based on its position in the table window. Use this constant with the Sal.TblGetColumnWindow function. 1 is the first (left-most) column in the table window.

COL_IndicateOverflow

This table column flag fills a table window cell with the overflow character ("#") when the text does not fit in the cell. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_Invisible

This table column flag indicates that a column is used to edit a password. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_LowerCase

This table column flag indicates that the cell format is lowercase. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_MultilineCell

This constant is used to define a column as a multi line column.

COL_ReadOnly

This table column flag indicates that the column cell is read only. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_RightJustify

This table column flag right-justifies text in a column. If this flag is set, you cannot also set the COL_CenterJustify flag at the same time. If you set neither COL_RightJustify nor COL_CenterJustify, then left-justifies the column text by default. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_Selected

This table column flag indicates that a column is selected. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_UpperCase

This table column flag indicates that the cell format is uppercase. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COL_Visible

This table column flag indicates that a column is visible. Use this constant with the Sal.TblSetColumnFlags and Sal.TblQueryColumnFlags functions.

COLOR_3DFace

The color of the window background (sometimes called the "button face" color). The default is light gray. However, a user can change the color of the window background by selecting a different color scheme. Specify this to make the color of the window background consistent with the color scheme set by the user. Use this constant with Sal.ColorGet and Sal.ColorSet.

COLOR_3DHighlight

The color of highlighted areas. The default is white. However, the user can change the color of highlighted areas by selecting a different color scheme. Specify this to make the color of highlighted areas consistent with the color scheme set by the user. Use this constant with Sal.ColorGet and Sal.ColorSet.

COLOR_3DShadow

The color of shadow areas. The default is dark gray. However, a user can change the color of shadow areas by selecting a different color scheme. Specify this to make the color of shadow areas consistent with the color scheme set by the user. Use this constant with Sal.ColorGet and Sal.ColorSet.

COLOR_Black

Black.

COLOR_Blue

Blue.

COLOR_Burgundy

Burgundy.

COLOR_Charcoal

Charcoal.

COLOR_Chartreuse

Chartreuse.

COLOR_Cyan

Cyan.

COLOR_DarkAqua

DarkAqua.

COLOR_DarkBlue

DarkBlue.

COLOR_DarkGray

DarkGray.

COLOR_DarkGreen

DarkGreen.

COLOR_DarkRed

DarkRed.

COLOR_Default

Default or empty color.

COLOR_Gray

Gray.

COLOR_Green

Green.

COLOR_IndexCell

This constant refers to the cell background color of the context row in a table window column. (You cannot set the color of the cell text in the Property window). Use this constant with the Sal.ColorGet and Sal.ColorSet functions.

COLOR_IndexCellText

This constant refers to the cell text color of the context row in a table window column. (You cannot set the color of the cell text in the Property window). Use this constant with the Sal.ColorGet and Sal.ColorSet functions.

COLOR_IndexTransparent

This constant refers to the transparent color in a picture or push button bitmap. For example, assume you have a push button that contains a bitmap that is blue, red, and green. If you set COLOR_IndexTransparent to COLOR_Blue, the blue portions of the bitmap become transparent; this allows the color of the form window underneath the push button to show through. Use this constant with the Sal.ColorGet and Sal.ColorSet functions.

COLOR_IndexWindow

This constant refers to the window's background color. Use this constant with the Sal.ColorGet, Sal.ColorGetSysColor, and Sal.ColorSet functions.

COLOR_IndexWindowText

This constant refers to the window's text color. Use this constant with the Sal.ColorGet, Sal.ColorGetSysColor, and Sal.ColorSet functions.

COLOR_Jade

Jade.

COLOR_LightAqua

LightAqua.

COLOR_LightGray

LightGray.

COLOR_LightGreen

LightGreen.

COLOR_LightPeriwinkle

LightPeriwinkle.

COLOR_Magenta

Magenta.

COLOR_Maize

Maize.

COLOR_Marigold

Marigold.

COLOR_MidnightBlue

MidnightBlue.

COLOR_None

This constant means that the transparent color has not been set. Sal.ColorGet can return this constant, and you can specify this constant in Sal.ColorSet.

COLOR_Orchid

Orchid.

COLOR_Periwinkle

Periwinkle.

COLOR_Purple

Purple.

COLOR_Red

Red.

COLOR_RoyalBlue

RoyalBlue.

COLOR_Salmon

Salmon.

COLOR_Sky

Sky.

COLOR_SysWindow

This constant refers to the window's background color. Use this constant with the Sal.ColorGetSysColor function.

COLOR_SysWindowFrame

This constant refers to the color of the window's frame. Use this constant with the Sal.ColorGetSysColor function.

COLOR_SysWindowText

This constant refers to the color of the window's text. Use this constant with the Sal.ColorGetSysColor function.

COLOR_Teal

Teal.

COLOR_White

White.

COLOR_Yellow

Yellow.

CREATE_AsChild

create as child

CREATE_Border

create border

CREATE_Hidden

create hidden window

CURSOR_Arrow

The standard arrow cursor. Use this constant with the Sal.CursorSet function.

CURSOR_Cross

A crosshair cursor. Use this constant with the Sal.CursorSet function.

CURSOR_DisableDrop

The cursor that displays when in drag mode and drop is disabled. Use this constant with the Sal.CursorSet and Sal.CursorSetFile functions.

CURSOR_DragDrop

The cursor that displays when in drag mode and drop is enabled. Use this constant with the Sal.CursorSet and Sal.CursorSetFile functions.

CURSOR_IBeam

A text (I-beam) cursor. Use this constant with the Sal.CursorSet function.

CURSOR_Icon

An empty icon. Use this constant with the Sal.CursorSet function.

CURSOR_Size

A cursor that looks like a square with a smaller square in its lower right corner. Use this constant with the Sal.CursorSet function.

CURSOR_SizeNESW

A double-pointed cursor with arrows pointing northeast and southwest. Use this constant with the Sal.CursorSet function.

CURSOR_SizeNS

A double-pointed cursor with arrows pointing north and south. Use this constant with the Sal.CursorSet function.

CURSOR_SizeNWSE

A double-pointed cursor with arrows pointing northwest and southeast. Use this constant with the Sal.CursorSet function.

CURSOR_SizeWE

A double-pointed cursor with arrows pointing west and east. Use this constant with the Sal.CursorSet function.

CURSOR_UpArrow

A vertical arrow cursor. Use this constant with the Sal.CursorSet function.

CURSOR_Wait

An hourglass cursor. Use this constant with the Sal.CursorSet function.

CURSOR_Window

The cursor that displays when positioned over a window and drag mode is not enabled. Use this constant with the Sal.CursorSet and Sal.CursorSetFile functions.

DATETIME_Null

Use this constant to set a Date/Time to a null value or to check if a Date/Time value is null.

DBP_AUTOCOMMIT

Use this constant to either get or set the value of a database parameter indicating the current autocommit status of the database. If autocommit is on (TRUE), the database commits changes automatically after each SQL command. If autocommit is off (FALSE), then the database commits changes only when you issue a COMMIT command. Use this constant with the Sql.GetParameter, and Sql.SetParameter functions. You can only use DBP_AUTOCOMMIT with databases which support this feature. Please refer to the appropriate database manuals for more information.

DBP_BRAND

Use this constant to obtain the brand of the database engine. Brand is represented by the numeric value of one of these constants: DBV_BRAND_ALLBASE 10 DBV_BRAND_AS400 7 DBV_BRAND_CINCOMSUPRA 20 DBV_BRAND_DB2 2 DBV_BRAND_INFORMIX 5 DBV_BRAND_INFORMIXONLINE 24 DBV_BRAND_NETWARE 6 DBV_BRAND_ORACLE 4 DBV_BRAND_ORACLE7 28 DBV_BRAND_OS2EE 3 DBV_BRAND_SQL 1 DBV_BRAND_SYBASE 8 Use this constant with the Sql.GetParameter.

DBP_FETCHTHROUGH

Use this constant to either get or set the status of a database parameter indicating the current status of the FETCHTHROUGH feature. FETCHTHROUGH enables you to retrieve rows directly from the database server instead of from the client's input message buffer, thereby ensuring that you get the most up-to-date data. If FETCHTHROUGH is on (TRUE), the application fetches data one row at a time from the backend. Using this feature increases response time, so you should only use this feature when you need to get the most up-to-date information. If FETCHTHROUGH is off (FALSE), the application fetches data from the client's input message buffer whenever possible. This is the default. Use this constant with the Sql.GetParameter, and Sql.SetParameter, functions. You can only use this feature against SQLBase.

DBP_ISOLEVEL

Isolation level: RR,RL,CS,RO,SE

DBP_LOCKWAITTIMEOUT

Use this constant to either get or set the value of a database parameter which specifies the number of seconds an application should wait for a database lock to be acquired before timing out. After the specified time has elapsed, SQLBase rolls back the transaction. The default timeout value is 300 seconds. Valid time out values are: 1-1800 Wait 1 second to 30 minutes -1 Wait forever 0 Never wait; immediately return a time out error. Use this constant with the Sql.GetParameter and Sql.SetParameter functions. You can only use this constant against databases which support the setting of lock wait timeout values. Please refer to the appropriate database manuals for more information.

DBP_NOPREBUILD

Use this constant to either get or set the value of a database parameter which specifies whether result sets should be pre-built on remote databases when the application is in result set mode and is using the Release Locks isolation level. Pre-building a result set provides the advantages of being able to release shared locks and returning control to the client. The disadvantage of pre-building a result set is that the application must wait while the result set is being built. If NOPREBUILD is on (TRUE), result sets are not pre-built. A shared lock remains on the current page. This is the default setting. If NOPREBUILD is off (FALSE), result sets are pre-built on the remote database. Use this constant with the Sql.GetParameter and Sql.SetParameter functions. You can only use this feature against SQLBase.

DBP_PRESERVE

Use this constant to get or set the value of the database parameter that specifies whether cursor context preservation is on or off. If cursor-context preservation is on (TRUE), a COMMIT does not destroy an active result set (cursor context). This enables an application to maintain its position after a COMMIT, INSERT, or UPDATE. The cursor context is not preserved after an isolation level change. The context is preserved after a ROLLBACK if both of the following are true: The application is in the Release Locks (RL) isolation level. A DDL operation was not performed. If cursor-context preservation is off (FALSE), a COMMIT does destroy an active result set. Cursor context preservation is lost. Use this constant with the Sql.GetParameter, and Sql.SetParameter functions.

DBP_ROLLBACKONTIMEOUT

Use this constant to either get or set the value of a database parameter which specifies the rollback status when a lock timeout occurs. If the parameter is TRUE, the entire transaction rolls back when a lock timeout occurs. If it is FALSE, only the current command rolls back on a lock timeout. Use this constant with the Sql.GetParameter, and Sql.SetParameter. The rollbackontimeout feature can only be used against some databases. Please see the appropriate database manuals for more information.

DBP_VERSION

Use this constant to get the version number of the server software. Use this constant with the Sql.GetParameter function.

DBV_BRAND_ALLBASE

DBV_BRAND_ALLBASE means that the application is accessing an ALLBASE database.

DBV_BRAND_APPLEDAL

DBV_BRAND_APPLEDAL means that the application is using an Apple DAL Interface.

DBV_BRAND_AS400

DBV_BRAND_AS400 means that the application is accessing an AS/400 database.

DBV_BRAND_CCAMODEL20

DBV_BRAND_CCAMODEL20 means that the application is accessing a CCA Model 204 database.

DBV_BRAND_CINCOMSUPRA

DBV_BRAND_CINCOMSUPRA means that the application is accessing a Cincom Supra database.

DBV_BRAND_DB2

DBV_BRAND_DB2 means that the application is accessing a DB2 database.

DBV_BRAND_DBASE

DBV_BRAND_DBASE means that the application is accessing a DBASE database.

DBV_BRAND_EDASQL

DBV_BRAND_EDASQL means that the application is accessing a Sybase database.

DBV_BRAND_IMBSQLDS

DBV_BRAND_IMBSQLDS means that the application is accessing a IBM SQL/DS database.

DBV_BRAND_INFORMIX

DBV_BRAND_INFORMIX means that the application is accessing an Informix database.

DBV_BRAND_INFORMIXONLINE

DBV_BRAND_INFORMIXONLINE means that the application is accessing an Informix Online database.

DBV_BRAND_INGRES

DBV_BRAND_INGRES means that the application is accessing a INGRES database.

DBV_BRAND_INGRESSOPENSQL

DBV_BRAND_INGRESSOPENSQL means that the application is accessing a Ingres OpenSQL database.

DBV_BRAND_INGRESSOPENSQLD

DBV_BRAND_INGRESSOPENSQLD means that the application is accessing a Ingres OpenSQL database with date support.

DBV_BRAND_MSSQL

DBV_BRAND_NOCOMMIMER means that the application is accessing a Nocom Mimer database.

DBV_BRAND_NETWARE

DBV_BRAND_NETWARE means that the application is accessing a Novell NetWare database.

DBV_BRAND_NETWARESQL

DBV_BRAND_NETWARE means that the application is accessing a Novell NetWare database.

DBV_BRAND_NOCOMMIMER

DBV_BRAND_NOCOMMIMER means that the application is accessing a Nocom Mimer database.

DBV_BRAND_NONSTOPSQL

This constant is returned by Sql.GetParameter when you specify DBP_BRAND means that the application is accessing a Tandem Nonstop SQL database.

DBV_BRAND_ODBC

DBV_BRAND_ODBC means that the application is accessing a database using an ODBC Router.

DBV_BRAND_ORACLE

DBV_BRAND_ORACLE means that the application is accessing an Oracle database.

DBV_BRAND_ORACLE7

DBV_BRAND_ORACLE7 means that the application is accessing an Oracle v. 7 database.

DBV_BRAND_ORACLE8

DBV_BRAND_ORACLE8 means that the application is accessing an Oracle v. 8 database.

DBV_BRAND_OS2EE

DBV_BRAND_OS2EE means that the application is accessing an IBM Database Manager database.

DBV_BRAND_RDB

This constant is returned by Sql.GetParameter when you specify DBP_BRAND CST_DBV_BRAND_RDB means that the application is accessing a DEC RDB database.

DBV_BRAND_RDBII

DBV_BRAND_RDBII means that the application is accessing a Fujitsu RDBII database.

DBV_BRAND_SHAREBASE

DBV_BRAND_SHAREBASE means that the application is accessing a Teradata Sharebase database.

DBV_BRAND_SNIDDB4

DBV_BRAND_SNIDDB4 means that the application is accessing a SNI DDB4 database.

DBV_BRAND_SNISESAM

DBV_BRAND_SNISESAM means that the application is accessing a SNI SESAM database.

DBV_BRAND_SNIUDS

DBV_BRAND_SNIUDS means that the application is accessing a SNI UDS database.

DBV_BRAND_SQL

DBV_BRAND_SQL means that the application is accessing a SQLBase database.

DBV_BRAND_SQLACCESS

DBV_BRAND_SQLACCESS means that the application is accessing a SQL Access database.

DBV_BRAND_SQLHOSTAPP

DBV_BRAND_SQLHOSTAPP means that the application using SQLHOST App Services.

DBV_BRAND_SYBASE

DBV_BRAND_SYBASE means that the application is accessing a Sybase database.

DBV_BRAND_SYSTEM10

Sql.GetParameter returns this constant when you specify DBP_BRAND and are accessing a Sybase System 10 database.

DBV_BRAND_TERADATA

DBV_BRAND_TERADATA means that the application is accessing a Teradata dbc database.

DDE_fAck

DDE_fBusy

DDE_fNoData

DDE_fRelease

DDE_fResponse

DOCK_Any

any docking

DOCK_Bottom

dock on bottom

DOCK_Left

dock to the left

DOCK_None

no docking

DOCK_Right

dock to the right

DOCK_Top

dock on top

DRIVE_CDROM

DRIVE_Fixed

DRIVE_Floppy

DRIVE_Network

DRIVE_RAM

DT_Boolean

This constant is returned by the Sal.GetDataType function. It indicates that the field or table window column is of type Boolean.

DT_DateTime

This constant is returned by the Sal.GetDataType function. It indicates that the field or table window column is of type Date/Time.

DT_LongString

This constant is returned by the Sal.GetDataType function. It indicates that the field or table window column is of type Long String.

DT_Number

This constant is returned by the Sal.GetDataType function. It indicates that the field or table window column is of type Number.

DT_String

This constant is returned by the Sal.GetDataType function. It indicates that the field or table window column is of type String.

DW_Default

This constant is returned by the Sal.GetMaxDataLength function when a data field, multi line text field, or table window column is declared with a length of "Default".

EVAL_Date

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to Date/Time.

EVAL_Handle

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to Window Handle.

EVAL_If

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to an If statement.

EVAL_Number

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to Number.

EVAL_Object

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Archive specifies that should retrieve only archived files. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

EVAL_Set

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to a SET expression.

EVAL_String

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to String.

EVAL_Template

This constant is returned by the Sal.CompileAndEvaluate function when the data type of an expression evaluates to Template.

EVENT_ERROR

error

EVENT_INFORMATION

information

EVENT_WARNING

warning

FA_Archive

This constant is returned by the SAl.CompileAndEvaluate function when the data type of an expression evaluates to an object.

FA_Directory

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Directory specifies that should retrieve only sub-directories within the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_Drive

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Drive specifies that should retrieve a list of drives to which the machine is currently connected. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_Exclusive

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Exclusive specifies that should retrieve only files of the specified type. If you do not specify FA_Exclusive, files of the specified type and FA_Standard files are listed with normal files. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_Hidden

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Hidden specifies that should retrieve all hidden files in the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_Queued

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Queued specifies that should retrieve queued files (such as those to be printed) in the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_ReadOnly

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_ReadOnly specifies that should retrieve only read-only files in the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_Standard

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_Standard specifies that should retrieve all read/write files in the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FA_System

One of the File Access constants used by the Sal.ListFiles function to define the type of files to retrieve and place in a list box. FA_System specifies that should retrieve all system files in the specified directory. This constant can be OR'd together with any of the other File Access (FA_*) constants to retrieve a variety of file types at the same time.

FETCH_Delete

This constant is returned to one of the SqlFetch* functions to indicate a failure in fetching the requested row. Could not fetch the row because it had been deleted from the query set since it was last fetched. Use this constant with the Sql.FetchNext, Sql.FetchPrevious, and Sql.FetchRow functions.

FETCH_EOF

This constant is returned to one of the SqlFetch* functions to indicate a failure in fetching the requested row. Could not fetch the row because it reached the end of the query set. Use this constant with the Sql.FetchNext, Sql.FetchPrevious, and Sql.FetchRow functions.

FETCH_Ok

This constant is returned to one of the SqlFetch* functions to indicate that the requested row was successfully fetched from the query set. Use this constant with the Sql.FetchNext, Sql.FetchPrevious, and Sql.FetchRow functions.

FETCH_Update

This constant is returned to one of the SqlFetch* functions to indicate a failure in fetching the requested row. Could not fetch the row because it had been updated since it was last fetched. Use this constant with the Sql.FetchNext, Sql.FetchPrevious, and Sql.FetchRow functions.

FILE_CopyDest

This constant is returned when the Sal.FileCopy function fails because it can not open the destination file.

FILE_CopyExist

This constant is returned when the Sal.FileCopy function fails because the destination file already exists and the bOverWrite parameter is FALSE.

FILE_CopyOK

This constant is returned when the Sal.FileCopy function successfully copies the contents of the source file to the destination file.

FILE_CopyRead

This constant is returned when the Sal.FileCopy function fails while reading the source file.

FILE_CopySrc

This constant is returned when the Sal.FileCopy function fails because the source file can not be opened.

FILE_CopyWrite

This constant is returned when the Sal.FileCopy function fails while writing to the destination file.

FILE_SeekBegin

Use this constant with the Sal.FileSeek function to position the file pointer at the beginning of a file.

FILE_SeekCurrent

Use this constant with the Sal.FileSeek function to position the file pointer at its current location in the file.

FILE_SeekEnd

Use this constant with the Sal.FileSeek function to position the file pointer at the end of the file.

FMT_Date_JapanEmperor

This constant is one of four possible integer format parameter values for a field. When the constant specifying which integer format parameter to get or set is FMT_Parm_iDateType, the integer format parameter value of a field can be FMT_Date_JapanEmperor. To use the JapanEmperor format, add a [GTITOOLS] section to WIN.INI, and set sDateType to JapanEmperor. In addition, set the sCountry parameter in the [INTL] section of WIN.INI to "Japan".

FMT_Date_JapanGregorian

This constant is one of four possible integer format parameter values for a field. When the constant specifying which integer format parameter to get or set is FMT_Parm_iDateType, the integer format parameter value of a field can be FMT_Date_JapanGregorian. To use the JapanGregorian format, add a [GTITOOLS] section to WIN.INI, and set sDateType to JapanGregorian. In addition, set the sCountry parameter in the [INTL] section of WIN.INI to "Japan".

FMT_Date_LongGregorian

This constant is one of four possible integer format parameter values for a field. When the constant specifying which integer format parameter to get or set is FMT_Parm_iDateType, the integer format parameter value of a field can be FMT_Date_LongGregorian. To use the LongGregorian format, add a [GTITOOLS] section to WIN.INI, and set sDateType to LongGregorian. This defaults to the format set by FMT_Parm_sLongDate.

FMT_Date_ShortGregorian

This constant is one of four possible integer format parameter values for a field. When the constant specifying which integer format parameter to get or set is FMT_Parm_iDateType, the integer format parameter value of a field can be FMT_Date_ShortGregorian. To use the ShortGregorian format, add a [GTITOOLS] section to WIN.INI, and set sDateType to ShortGregorian. This defaults to the format set by FMT_Parm_sShortDate.

FMT_Format_Currency

This constant is used to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a number field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to currency, and it is used by the function Sal.FmtSetFormat to set a field or column's format to currency.

FMT_Format_Date

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a date field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to date, and it is used by the function Sal.FmtSetFormat to set a field or column's format to date.

FMT_Format_DateTime

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a date/time field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to date/time, and it is used by the function Sal.FmtSetFormat to set a field or column's format to date/time.

FMT_Format_Decimal

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a number field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to decimal, and it is used by the function Sal.FmtSetFormat to set a field or column's format to decimal.

FMT_Format_Invisible

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a string field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to invisible, and it is used by the function Sal.FmtSetFormat to set a field or column's format to invisible.

FMT_Format_LowerCase

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a string field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to lowercase, and it is used by the function Sal.FmtSetFormat to set a field or column's format to lowercase.

FMT_Format_Percentage

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a number field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to percentage, and it is used by the function Sal.FmtSetFormat to set a field or column's format to percentage.

FMT_Format_Picture

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a field or column of number or date/time data type. This constant is returned by the function Sal.FmtGetFormat when a field or column has been picture-formatted, and it is used by the function Sal.FmtSetFormat to set a field or column to be picture-formatted.

FMT_Format_Time

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a time field. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to time, and it is used by the function Sal.FmtSetFormat to set a field or column's format to time.

FMT_Format_Unformatted

Use this constant to get or set the format of a data field or table window column of any data type. This constant is returned by the function Sal.FmtGetFormat when the format of a field or column is set to unformatted, and it is used by the function Sal.FmtSetFormat to set a field or column's format to unformatted.

FMT_Format_UpperCase

Use this constant to get or set the format of a data field or table window column. The format of a field or column must agree with its data type, so this constant can only be returned by or applied to a string field. This constant is returned by the function Sal.FmtGetFormat when the format of the field or column is set to uppercase, and it is used by the function Sal.FmtSetFormat to set a field or column's format to uppercase.

FMT_Parm_iCurrDigits

Use this constant to obtain and define a field's profile-driven format. It represents the number of digits in the fractional part of a currency amount.

FMT_Parm_iCurrency

Use this constant to obtain and define a field's profile-driven format. When you specify FMT_Parm_iCurrency, the integer format parameter value of a field can be one of the following: FMT_Prefix_NoSeparation FMT_Suffix_NoSeparation FMT_Prefix_Separation FMT_Suffix_Separation

FMT_Parm_iDateType

Use this constant to obtain and define a field's profile-driven format. When you specify FMT_Parm_iDateType, the integer format parameter value of a field can be one of the following: FMT_Date_LongGregorian FMT_Date_ShortGregorian FMT_Date_JapanGregorian FMT_Date_JapanEmperor

FMT_Parm_iDigits

Use this constant to obtain and define a field's profile-driven format. It represents the number of significant digits to the right of a number's decimal point. When you specify FMT_Parm_iDigits, the integer format parameter value of a field is the number of digits.

FMT_Parm_iLzero

Use this constant to obtain and define a field's profile-driven format. It indicates whether or not to use a leading zero with decimal values less than 1.0 and greater than -1.0. When you specify FMT_Parm_iLzero, the integer format parameter value of a field can be one of the following: 0 indicates no leading zero (.7) 1 indicates a leading zero (0.7)

FMT_Parm_iNegCurr

Use this constant to obtain and define a field's profile-driven format. It represents the negative currency format. When you specify FMT_Parm_iNegCurr, the integer format parameter value of a field can be one of the following: 0 for ($1) 1 for -$1 2 for $-1 3 for $1- 4 for (1$) 5 for -1$ 6 for 1-$ 7 for 1$-

FMT_Parm_iTime

Use this constant to obtain and define a field's profile-driven format. It represents the time format. When you specify FMT_Parm_iTime, the integer format parameter value of a field can be one of the following: FMT_Time_12Hour FMT_Time_24Hour

FMT_Parm_iTLZero

Use this constant to obtain and define a field's profile driven format. It indicates whether or not hours have a leading zero. When you specify FMT_Parm_iTLZero, the integer format parameter value of a field can be 0, meaning that there is no leading zero.

FMT_Parm_s1159

Use this constant to obtain and define a field's profile-driven format. It represents the trailing string for times between 0:00 and 11:59 A.M. When you specify FMT_Parm_s1159, the string format parameter value can have a length of up to 3 characters.

FMT_Parm_s2359

Use this constant to obtain and define a field's profile-driven format. It represents the trailing string for times between 12:00 and 23:59 P.M. When you specify FMT_Parm_s2359, the string format parameter value can have a length of up to 3 characters.

FMT_Parm_sCurrency

Use this constant to obtain and define a field's profile-driven format. It represents the currency symbol for a given country. When you specify FMT_Parm_sCurrency, the string format parameter value can have a length of up to 40 characters.

FMT_Parm_sDecimal

Use this constant to obtain and define a field's profile-driven format. It represents the symbol that separates the integer and fractional parts of a number.

FMT_Parm_sLongDate

Use this constant to obtain and define a field's profile-driven format. It represents a long date picture format such as d MMM, yyyy.

FMT_Parm_sShortDate

Use this constant to obtain and define a field's profile-driven format. It represents a short date picture format such as M/d/yy.

FMT_Parm_sThousand

Use this constant to obtain and define a field's profile-driven format. It represents the thousands separator character.

FMT_Parm_sTime

Use this constant to obtain and define a field's profile-driven format. It represents the time separator character. For instance, (:) is the separator in (9:25).

FMT_Pic_DateTime

This constant specifies that the picture format to validate is a date/time picture format. Use FMT_Pic_DateTime with the Sal.FmtIsValidPicture function. Valid date/time picture format values: Value Item Appearance M month 1-12 MM month 01-12 MMM month Jan-Dec MMMM month January-December d day 1-31 dd day 01-31 ddd day Mon-Sun dddd day Monday-Sunday yy year 00-99 yyyy year 0000-9999 hh hour 1-12 hhhh hour 0-24 mm minutes 0-59 ss seconds 0-59 mmmmmm microseconds 000000-999999 AMPM AM/PM The AM/PM indicator

FMT_Pic_Number

This constant specifies that the picture format to validate is a number picture format. Use FMT_Pic_Number with the Sal.FmtIsValidPicture function. Valid number formats are: # Specifies the number of optional digits on both sides of the decimal point. 0 Specifies the number of decimal places to the right of the decimal point, and the minimum digits to the left of the decimal point. . Indicates the position of the decimal point. , Specifies the thousands separator when nested between 0's or #'s. ; Specifies that there are two picture formats. The picture format to the left of the (;) is used to format positive values, and the picture format to the right of the (;) is used to format negative values. % Specifies percentage format. E+ e+ E- e- Specifies scientific notation format. By specifying a (-), only negative numbers are displayed with a sign.

FMT_Prefix_NoSeparation

This constant is one of four possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_Parm_iCurrency. It defines the way in which formats a currency value. If you specify this constant, a number (for example: 1) to be formatted as currency appears as: $1.

FMT_Prefix_Separation

This constant is one of four possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_Parm_iCurrency. It defines the way in which formats a currency value. If you specify this constant, a number (for example: 1) to be formatted as currency appears as: $ 1.

FMT_Profile_Australia

Australia

FMT_Profile_Belgium

Belgium

FMT_Profile_Brazil

Brazil

FMT_Profile_Default

This constant represents the system default profile maintained in the WIN.INI file. The settings associated with the system default profile determine a field's format.

FMT_Profile_Denmark

Denmark

FMT_Profile_Finland

Finland

FMT_Profile_France

France

FMT_Profile_Germany

Germany

FMT_Profile_Italy

Italy

FMT_Profile_Japan

japan

FMT_Profile_Netherlands

Netherlands

FMT_Profile_Norway

Norway

FMT_Profile_Program

This constant represents a special profile whose settings determine a field's format. It allows an application to individually specify each field's format.

FMT_Profile_Spain

Spain

FMT_Profile_Sweden

Sweden

FMT_Profile_Switzerland

Switzerland

FMT_Profile_UnitedKingdom

UK

FMT_Profile_USA

USA

FMT_Suffix_NoSeparation

This constant is one of four possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_iCurrency. It defines the way in which formats a currency value. If you specify this constant, a number (for example: 1) to be formatted as currency appears as: 1$.

FMT_Suffix_Separation

This constant is one of four possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_iCurrency. It defines the way in which formats a currency value. If you specify this constant, a number (for example: 1) to be formatted as currency appears as: 1 $.

FMT_Time_12Hour

This constant is one of two possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_Parm_iTime. It defines a time value to display in the format of a 12 hour clock.

FMT_Time_24Hour

This constant is one of two possible integer format parameter values for a field whose integer format parameter is specified by the constant FMT_Parm_iTime. It defines a time value to display in the format of a 24 hour clock.

FMT_Validate_Dialog

This constant directs to display a dialog box if a format error occurs during a call to Sal.FmtValidateField.

FMT_Validate_None

This constant directs not to display a dialog box if a format error occurs during a call to Sal.FmtValidateField. Instead, the application handles the error.

FONT_EnhBold

This is a font enhancement constant which instructs to bold the specified window's text. You can combine FONT_EnhBold with other font enhancement constants using the OR (|) operator. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_EnhDefault

This is a font enhancement constant which indicates that the specified window's text should conform to the current default settings. You can combine FONT_EnhDefault with other font enhancement constants using the OR (|) operator. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_EnhItalic

This is a font enhancement constant which instructs to italicize the specified window's text. You can combine FONT_EnhItalic with other font enhancement constants using the OR (|) operator. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_EnhNormal

This is a font enhancement constant which indicates that there are no enhancements to add to the text in the specified window. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_EnhStrikeOut

This is a font enhancement constant which instructs to strike out the specified window's text. You can combine FONT_EnhStrikeOut with other font enhancement constants using the OR (|) operator. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_EnhUnderline

This is a font enhancement constant which instructs to underline the specified window's text. You can combine FONT_EnhUnderline with other font enhancement constants using the OR (|) operator. Use this constant with the Sal.FontGet and Sal.FontSet functions.

FONT_GetPrinter

Use this constant to obtain either a list of available printer fonts or a list of available printer font sizes for a given font. Use this constant with the Sal.FontGetNames and Sal.FontGetSizes functions.

FONT_GetScreen

Use this constant to obtain either a list of available screen font names or a list of available screen font sizes. Use this constant with the Sal.FontGetNames and Sal.FontGetSizes functions.

FORM_nFormHeight

This constant represents the integer form parameter for the height of a given form window. It is used by the function Sal.FormGetParmNum.

FORM_nFormPages

This constant represents the integer form parameter for the number of pages in a given form window. It is used by the function Sal.FormGetParmNum.

FORM_nFormWidth

This constant represents the integer form parameter for the width of a given form window. It is used by the function Sal.FormGetParmNum.

HELP_Context

The Sal.WinHelp function uses this constant to display context sensitive help on the topic associated with the context identifier number in the nData parameter.

HELP_Finder

The Sal.WinHelp function uses this constant to bring up the help Find Dialog.

HELP_HelpOnHelp

The Sal.WinHelp function uses this constant to display information on the Windows Help System itself.

HELP_Index

The Sal.WinHelp function uses this constant to display the index of available Help topics.

HELP_Key

The Sal.WinHelp function uses this constant to display a list of available Help topics for the keywords specified in the parameter sData.

HELP_Quit

The Sal.WinHelp function uses this constant to quit the Windows Help System that is currently open and in use.

HELP_SetIndex

The Sal.WinHelp function uses this constant to set the current index for a multi-index help system.

hWndForm

Window handle of the current form or dialog.

hWndItem

Window handle of the current control.

hWndMDI

Window handle of the current MDI.

hWndNULL

Use this to detect if a function that returns a window handle succeeded.

IDABORT

This constant is returned by the Sal.MessageBox function when you click on the Abort push button in an Abort/Retry/Ignore message box (MB_AbortRetryIgnore).

IDCANCEL

This constant is returned by the Sal.MessageBox function when you click on the Cancel push button in an OK/Cancel message box (MB_OkCancel), a Retry/Cancel message box (MB_RetryCancel) or a Yes/No/Cancel message box (MB_YesNoCancel).

IDIGNORE

This constant is returned by the Sal.MessageBox function when you click on the Ignore push button of an Abort/Retry/Ignore message box (MB_AbortRetryIgnore).

IDNO

This constant is returned by the Sal.MessageBox function when you click on the No push button of a Yes/No message box (MB_YesNo) or a Yes/No/Cancel message box (MB_YesNoCancel).

IDOK

This constant is returned by the Sal.MessageBox function when you click on the Ok push button of an Ok message box (MB_Ok) or an Ok/Cancel message box (MB_OkCancel).

IDRETRY

This constant is returned by the Sal.MessageBox function when you click on the Retry push button of a Retry/Cancel message box (MB_RetryCancel) or an Abort/Retry/Ignore message box (MB_AbortRetryIgnore).

IDYES

This constant is returned by the Sal.MessageBox function when you click on the Yes push button of a Yes/No message box (MB_YesNo) or a Yes/No/Cancel message box (MB_YesNoCancel).

LB_Err

This constant is returned by a Sal.List* function call when a user error occurs. It is used by the functions: Sal.ListAdd, Sal.ListDelete, Sal.ListInsert, Sal.ListQueryCount, Sal.ListQueryMultiCount, Sal.ListQuerySelection, Sal.ListQueryText, Sal.ListQueryTextLength, Sal.ListSelectString.

LB_ErrSpace

This constant is returned when insufficient memory is available to store a new string in a list box. Use this constant with the Sal.ListAdd and Sal.ListInsert functions.

LB_Ok

LB_Ok is returned by a Sal.List* function that completes successfully.

lParam

The lParam value used in the last message.

MAX_DefaultDataField

This constant represents the default length of a data field (100 characters).

MAX_DefaultMultiline

This constant represents the default length of a multi line text field (1000 characters).

MB_AbortRetryIgnore

This is a Push Button style constant used by the Sal.MessageBox function to define the type of push buttons to display in the message box. Specifying MB_AbortRetryIgnore causes the message box to display three push buttons: Abort, Retry, and Ignore. You can combine a Push Button style constant with a constant from the Icon style, Response Button Handling style, and System style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_ApplModal

This is a System style constant used by the Sal.MessageBox function to display a dialog box that suspends the application's windows until you respond appropriately. You can combine a System style constant with a constant from the Icon style, Response Button Handling style, and Push Button style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_DefButton1

This is a Response Button Handling style constant used by the Sal.MessageBox function to specify that the first button (usually Ok) has the focus when the dialog box displays. You can combine a Response Button Handling style constant with a constant from the Icon style, System Options style, and Push Button style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_DefButton2

This is a Response Button Handling style constant used by the Sal.MessageBox function to specify that the second button has the focus when the dialog box displays. You can combine a Response Button Handling style constant with a constant from the Icon style, System Options style, and Push Button style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_DefButton3

This is a Response Button Handling style constant used by the Sal.MessageBox function to specify that the third button has the focus when the dialog box displays. You can combine a Response Button Handling style constant with a constant from the Icon style, System Options style, and Push Button style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_IconAsterisk

This is an icon style constant used by the Sal.MessageBox function to display an "i" (for information) icon in the message box. You can combine an icon style constant with a constant from the push button style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_IconExclamation

This is an icon style constant used by the Sal.MessageBox function to display an exclamation point icon in the message box. You can combine an icon style constant with a constant from the push button style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_IconHand

Supports MB_IconHand for backward compatibility; use MB_IconStop instead.

MB_IconInformation

This is an icon style constant used by the Sal.MessageBox function to display an "i" (for information) icon in the message box. You can combine an icon style constant with a constant from the push button style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_IconQuestion

This is an icon style constant used by the Sal.MessageBox function to display a question mark icon in the message box. You can combine an icon style constant with a constant from the push button style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_IconStop

This is an icon style constant used by the Sal.MessageBox function to display a stop sign icon in the message box. You can combine an icon style constant with a constant from the push button style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_NoFocus

The underlying Windows feature for this style is no longer supported by Microsoft. This style does nothing and is provided for backward compatibility only.

MB_Ok

This is a push button style constant used by the Sal.MessageBox function to display an Ok push button in the message box. This is the default assignment. You can combine a push button style constant with a constant from the icon style, default button style, and modal style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_OkCancel

This is a Push Button style constant used by the Sal.MessageBox function to specify that both an Ok and a Cancel push button display in the message box. You can combine a Push Button style constant with a constant from the Icon style, Response Button Handling style, and System style constant groups (all of which are also named MB_*) using the OR (|) operator. See Sal.MessageBox Options and Sal.MessageBox Returns for more information.

MB_RetryCancel

This is a Push Button style constant used by the Sal.MessageBox function to specify that both a Retry and a Cancel push button display in the message box. You can combine a Push Button style constant with a constant from the Icon style, Response Button Handling style, and System style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_SystemModal

This is a System style constant used by the Sal.MessageBox function to display a dialog box that suspends ALL application windows until you respond appropriately. You can combine a System style constant with a constant from the Icon style, Response Button Handling style, and Push Button style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_YesNo

This is a Push Button style constant used by the Sal.MessageBox function to specify that both a Yes and a No push button display in the message box. You can combine a Push Button style constant with a constant from the Icon style, Response Button Handling style, and System style constant groups (all of which are also named MB_*) using the OR (|) operator.

MB_YesNoCancel

This is a Push Button style constant used by the Sal.MessageBox function to define the type of push buttons to display in the message box. Specifying MB_YesNoCancel causes the message box to display three push buttons: Yes, No, and Cancel. You can combine a Push Button style constant with a constant from the Icon style, Response Button Handling style, and System style constant groups (all of which are also named MB_*) using the OR (|) operator.

Namespace

The application's main name space.

nArgCount

This variable's value is equal to the number of command line arguments you enter.

NUMBER_Null

Use this constant to set a Number to a null value or to check if a Number value is a null.

OF_Append

This constant instructs to open a file for appending. The file pointer is positioned at the end of the file. You can combine File Open style constants using the bitwise OR (|) operator. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Binary

This constant instructs to open a file in binary mode. Default translations of carriage return/line feed combinations are suppressed. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Create

This constant instructs to create a new file. If one already exists, it is truncated to zero length. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Delete

This constant instructs to delete a file. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Exist

This constant instructs to open and then close a file. Use it to test if a file exists. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Parse

This constant prepares to open a file by parsing the file specifications, but carries out no action. Use it if you need to verify a file specification without actually opening the file. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Read

This constant instructs to open a file for reading only. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_ReadAppend

This constant instructs to open a file for reading and appending of new data. The file pointer is positioned at the end of the file so that you can read/write the opened file. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_ReadWrite

This constant instructs to open a file for reading and writing. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Reopen

Use this constant only with the Sal.FileOpenExt function to instruct to open a file using the name specified in a previous Sal.FileOpen call. You must have previously opened the file with a legitimate file name and used the same file handle. When first opens the file, it stores the full path name internally. The purpose of the OF_Reopen constant is to guarantee that subsequent opens of the file use this fully qualified name, regardless of whether directories and drives have changed since the original Sal.FileOpen.

OF_Share_Compat

This constant instructs to open a file in compatibility mode. This lets any computer open a file any number of times. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Share_Deny_None

This constant instructs to open a file without denying other applications read and write access to it. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Share_Deny_Read

This constant instructs to open a file and deny other applications read access to it. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Share_Deny_Write

This constant instructs to open a file, denying other applications write access to it. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Share_Exclusive

This constant instructs to open a file, denying other applications read and write access to it. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Text

This constant instructs to open a file in text mode. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Unicode

This constant instructs to open a file in unicode mode. Default translations of carriage return/line feed combinations are suppressed. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_UTF16

This constant instructs to open a file in UTF16 mode.

OF_UTF7

This constant instructs to open a file in UTF7 mode. Default translations of carriage return/line feed combinations are suppressed. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_UTF8

This constant instructs to open a file in UTF8 mode. Default translations of carriage return/line feed combinations are suppressed. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

OF_Write

This constant instructs to open a file for writing only. Use this constant with the Sal.FileOpen and Sal.FileOpenExt functions.

PIC_FitBestFit

Use this constant with the Sal.PicSetFit function to set the fit for a picture. PIC_FitBestFit causes the image to fit either the width or height of the window. Scaling is proportional and the image is not distorted.

PIC_FitScale

Use this constant with the Sal.PicSetFit function to set the fit for a picture. PIC_FitScale scales the image by the percentages specified in nScaleWidth and nScaleHeight. Scaling may not be proportional and the image might be distorted.

PIC_FitSizeToFit

Use this constant with the Sal.PicSetFit function to set the fit for a picture. PIC_FitSizeToFit stretches or shrinks the image to fit within the picture frame. This is not proportional scaling and might distort the image.

PIC_FormatBitmap

Use this constant with the Sal.PicSetString, Sal.PicGetString, and Sal.PicSet functions to set the contents of a picture from a string. PIC_FormatBitmap means that the picture is a bitmap. You can also use this constant with Sal.PicSetHandle to set the image in a picture window with the handle of a bitmap.

PIC_FormatIcon

Use this constant with the Sal.PicSetString and Sal.PicSet functions to set the contents of a picture from a string. PIC_FormatIcon means that the picture is an icon. You can also use this constant with Sal.PicSetHandle to set the image in a picture window with the handle of an icon.

PIC_FormatObject

Use this constant with the Sal.PicSetString and Sal.PicGetString functions to set the contents of a picture from a string. PIC_FormatObject means that the picture is an OLE object.

PIC_ImageTypeBMP

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeBMP means that the picture is a .BMP.

PIC_ImageTypeGIF

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeGIF means that the picture type is .GIF.

PIC_ImageTypeICON

Use this constant with the Sal.PicSetImage function to set the contents of a picture without the CTD image header. PIC_ImageTypeICON means that the picture type is .ICON. Note: This constant is not supported for Sal.PicGetImage.

PIC_ImageTypeJPEG

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeJPEG means that the picture type is JPEG.

PIC_ImageTypeNone

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeNone means that the picture has no type.

PIC_ImageTypeNuVEQ

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeNuVEQ means that the picture type is NuVEQ. Note: This type is supported in Japan. It is also supported if you have an ImageMan license.

PIC_ImageTypePCX

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypePCX means that the picture type is .PCX.

PIC_ImageTypeTIFF

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeTIFF means that the picture type is .TIFF.

PIC_ImageTypeWMF

Use this constant with the Sal.PicSetImage and Sal.PicGetImage functions to set the contents of a picture without the CTD image header. PIC_ImageTypeWMF means that the picture type is .WMF.

PLATFORM_Current

An application interrogates its runtime environment to determine whether it is running on Microsoft Windows. An application may want to check the value of PLATFORM_Current if it has code paths that it will or will not execute depending on the operating system it is running on.

PLATFORM_Solaris

This constant identifies the operating system on which an application is running as SunSoft's Solaris.

PLATFORM_Windows

This constant identifies the operating system on which an application is running as Microsoft Windows.

PRT_nCopyCount

Use this constant to get and set the number of copies to print. The default setting is 1. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nDraftMode

Use this constant to get and set the print mode to either Draft or Proof. Draft mode prints faster than Proof mode, but with lower resolution. The default setting is Draft. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nFromPage

This constant gets and sets the first page to print. The default starting page number is 1. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nMarginLeft

This constant gets and sets the left margin. The default left margin is 0. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nMarginTop

This constant gets and sets the top margin. The default left margin is 0. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nPrintAll

Use this constant to determine or specify whether all pages of a form are to print. It overrides PRT_nFromPage and PRT_nToPage settings. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nShowFormPageRect

Use this constant to determine or specify whether a rectangle is drawn around the printed form using the form size. The default setting for this constant is FALSE. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

PRT_nToPage

This constant gets and sets the last page to print. The default ending page number is 1. Use this constant with the Sal.PrtGetParmNum, Sal.PrtSetParmNum, and Sal.PrtSetParmDefaults functions.

ROW_Edited

This flag indicates that a row was edited. ROW_Edited is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, SalTblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_Hidden

This flag indicates that a row is hidden from view. ROW_Hidden is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_HideMarks

This flag indicates that the row's editing marks (in the row header) are hidden from view. ROW_HideMarks is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_MarkDeleted

This flag indicates that the row is marked for deletion. ROW_MarkDeleted is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_New

This flag indicates that the row has been newly inserted. ROW_New is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_Selected

This flag indicates that the row is selected. ROW_Selected is returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_UnusedFlag1

This flag is available for your application to use. ROW_UnusedFlag1 can be returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

ROW_UnusedFlag2

This flag is available for your application to use. ROW_UnusedFlag2 can be returned or used by a number of table window row functions to set or determine the current status of a row. You can combine ROW_* flags using the OR (|) operator. Use with the functions: Sal.TblAnyRows, Sal.TblCopyRows, Sal.TblFindNextRow, Sal.TblFindPrevRow, Sal.TblQueryRowFlags, Sal.TblSetFlagsAnyRows, Sal.TblSetRowFlags.

RPT_BeforeBreakFooter1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formated. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formated. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakFooter8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakFooter1 through RPT_BeforeBreakFooter8 are after a report's detail block.

RPT_BeforeBreakHeader1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeBreakHeader8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be formatted. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeBreakHeader1 through RPT_BeforeBreakHeader8 are before a report's detail block.

RPT_BeforeDetail

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when a part of a report is ready to be processed. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforeDetail indicates it is ready to process the detail block.

RPT_BeforePageFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message when a part of a report is ready to be processed. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforePageFooter indicates that it is ready to process the bottom of a page.

RPT_BeforePageHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message when a part of a report is ready to be processed. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforePageHeader indicates that it is ready to process the top of a page.

RPT_BeforeReportFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message when a part of a report is ready to be processed. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforePageHeader indicates that it is ready to process the top of a page.

RPT_BeforeReportHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message when a part of a report is ready to be processed. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_BeforePageHeader indicates that it is ready to process the top of a page.

RPT_CmdFirstPage

Use this constant with the Sal.ReportCmd function to display the first page of a report.

RPT_CmdGoToPage

Use this constant with the Sal.ReportCmd function to display a dialog box where the user can enter the page number in the report to scroll to.

RPT_CmdLastPage

Use this constant with the Sal.ReportCmd function to display the last page of a report.

RPT_CmdNextPage

Use this constant with the Sal.ReportCmd function to display the next page of a report.

RPT_CmdPrevPage

Use this constant with the Sal.ReportCmd function to display the previous page of a report.

RPT_CmdPrint

Use this constant with the Sal.ReportCmd function to print the report.

RPT_CmdPrinterSetup

Use this constant with the Sal.ReportCmd function to display the Printer Setup dialog box where the user can change the print settings.

RPT_CmdSizeActual

Use this constant with the Sal.ReportCmd function to display a report in its true size in the report window. The user may need to scroll the window horizontally or vertically to see the entire report.

RPT_CmdSizeFit

Use this constant with the Sal.ReportCmd function fit the report within the report window. This is useful when you want to view the general format of a report as it appears when printed.

RPT_DoneBreakFooter1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakFooter8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakFooter1 through RPT_DoneBreakFooter8 are after a report's detail block.

RPT_DoneBreakHeader1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneBreakHeader8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneBreakHeader1 through RPT_DoneBreakHeader8 are before a report's detail block.

RPT_DoneDetail

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneDetail indicates that the detail block has just been processed.

RPT_DonePageFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DonePageFooter indicates that it has just processed the bottom of a page.

RPT_DonePageHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DonePageHeader indicates that it has just processed the top of a page.

RPT_DoneReportFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneReportFooter indicates that it has processed the end of the report.

RPT_DoneReportHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when the formatting of a part of a report is finished. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report has just been processed. RPT_DoneReportHeader indicates that it has completed processing the beginning of the report.

RPT_EnableCancel

Use this constant to enable the cancel button in the report preview panel. It should be specified in the nFlags parameter of Sal.ReportView function.

RPT_ErrBind

RPT_ErrBind means that a bind error occurred. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrCount

RPT_ErrCount means that a report function provided the wrong number of bind/input variables. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrFilenameLength

RPT_ErrFilenameLength means that the specified report file name was too long. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrFileOpen

RPT_ErrFileOpen means that a report function was unable to open the specified report file. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrInput

RPT_ErrInput means that a mismatch occurred between the input variable and the associated bind variable. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrLoadDLL

RPT_ErrLoadDLL means that a report function was unable to load the required DLLs. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrMaxRpts

RPT_ErrMaxRpts means that the maximum number of reports was exceeded. Maximum number of reports = 10. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrPrtOpen

RPT_ErrPrtOpen means that a report function was unable to open the printer. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrRptOpen

RPT_ErrRptOpen means that a report function was unable to open the specified report for printing. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrRptWindow

RPT_ErrRptWindow means that a report function was unable to open the report window. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView.

RPT_ErrType

RPT_ErrType means that the data type of an input variable did not match the data type of the associated bind variable. Returned by the functions: Sal.ReportCreate, Sal.ReportPrint, Sal.ReportPrintToFile, Sal.ReportView, Sal.ReportTableCreate, Sal.ReportTablePrint, Sal.ReportTableView

RPT_ExportDataOnly

Use this constant to indicate that the reporting engine should export only the data records.

RPT_Landscape

RPT_NoPrint

You can turn off the printer icon on the default report view toolbar by specifying this flag in the nFlags parameter of the Sal.ReportView function: RPT_NoPrint No print button on the toolbar

RPT_NoToolbar

You can turn off the toolbar in report view by specifying this flag in the nFlags parameter of the Sal.ReportView function: RPT_NoToolbar No toolbar in the preview window

RPT_OutputBreakFooter1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakFooter8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakFooter1 through RPT_OutputBreakFooter8 are after a report's detail block.

RPT_OutputBreakHeader1

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader2

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader3

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader4

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader5

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader6

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader7

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputBreakHeader8

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputBreakHeader1 through RPT_OutputBreakHeader8 are before a report's detail block.

RPT_OutputDetail

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputDetail indicates that itlder is ready to process the detail block.

RPT_OutputPageFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputPageFooter indicates that it is ready to process the bottom of a page.

RPT_OutputPageHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputPageHeader indicates that it is ready to process the top of a page.

RPT_OutputReportFooter

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputPageHeader indicates that it is ready to process the end of the report.

RPT_OutputReportHeader

Use this constant in a SAM_ReportNotify message's lParam. The SAM_ReportNotify message is send when it has formatted a block, but before it is actually output. When you process SAM_ReportNotify, you can check the lParam parameter value to see which part of the report is ready to be processed. RPT_OutputPageHeader indicates that it is ready to process the beginning of the report.

RPT_PaperA3

RPT_PaperA4

RPT_PaperA5

RPT_PaperB5

RPT_PaperCustom

RPT_PaperLegal

RPT_PaperLetter

RPT_PaperTabloid

RPT_Portrait

RPT_PrintAll

Use this constant with the Sal.ReportPrint function or the ReportPrint function to print all pages of a report.

RPT_PrintDraft

Use this constant with the Sal.ReportPrint function or the ReportPrint function to print a report in draft mode. ///

RPT_PrintEmptyReport

Use this constant to print reports with empty data sets. This option adds one empty row to the data set passed to the reporting engine. ReportPrint

RPT_PrintNoAbort

Use this constant with the Sal.ReportPrint function or the ReportPrint function so that does not display the dialog box that lets the user cancel the report.

RPT_PrintNoErrors

Use this constant with the Sal.ReportPrint function or the ReportPrint function to suppress error message dialog boxes during printing.

RPT_PrintNoWarn

Use this constant with the Sal.ReportPrint function or the ReportPrint function to suppress warnings about margin overflow and tiled pages.

RPT_PrintNullStringsAsDefaultValues

Use this constant to pass NULL strings as strings with length 0 ReportPrint

RPT_PrintParamCopies

Use this flag with the ReportPrint function to specify the number of copies to print.

RPT_PrintParamFirstPage

Use this flag with the ReportPrint function to specify the first page to print.

RPT_PrintParamLastPage

Use this flag with the ReportPrint function to specify the last page to print.

RPT_PrintParamOptions

Use this flag with the ReportPrint function to specify report options: RPT_PrintAll, RPT_PrintDraft, RPT_PrintNoAbort, RPT_PrintNoErrors, RPT_PrintNoWarn, or RPT_PrintRange.

RPT_PrintRange

Use this constant with the ReportPrint function or the Sal.ReportPrintToFile function to print a range of pages. You must also set the values of the first (nFirstPage) and last (nLastPage) pages of the report.

RPT_PrintTableHiddenColumns

Use this constant to include hidden columns when printing table windows ReportPrint

SAL_ARRAY

SAL_BOOLEAN

SAL_DATE

SAL_NOTYPE

SAL_NUMBER

SAL_OBJECT

SAL_STRING

SAL_VARIANT

SAM_Activate

SAM_Activate is sent to top-level and MDI windows when the window is activated or deactivated. The wParam indicates whether the window is being activated or deactivated. Message Variables hWndForm Handle of top-level window. hWndItem Object handle. wParam Whether the window is being activated or deactivated: TRUE = Activated FALSE = Deactivated IParam Unused.

SAM_AnyEdit

SAM_AnyEdit is sent to a combo box, data field, multi line text field, or table window column whenever you make a change to that object's value. The object receives a SAM_AnyEdit message on every key stroke. By processing SAM_AnyEdit messages, an application can check an object's value as it changes. Message Variables For a data field, combo box, or multi line text field: hWndForm Window handle of the parent window. hWndItem Window handle of the object. wParam Unused. IParam Unused. For a table window column: hWndForm Window handle of the table window. hWndItem Window handle of the column. wParam Unused. IParam Row number of the table window.

SAM_AppExit

SAM_AppExit is sent to an application after all of the application's windows have been destroyed (closed). When the user exits an application or switches from user mode to design mode, an application's form windows, dialog boxes, and table windows are destroyed. Following this, SAM_AppExit is sent to the application. You can perform clean-up tasks (such as disconnecting from a database) before the application terminates. This is the last message an application receives and it is only sent to the Application Actions section of the outline. Be sure not to reference any windows in your statements when processing this message! Message Variables hWndForm None. hWndItem None. wParam None. IParam None.

SAM_AppStartup

SAM_AppStartup is sent to an application before any of the application's windows have been created, including those which are automatically created at run time. You can process SAM_AppStartup and perform initialization tasks such as displaying a login dialog box that authorizes access to a database. This is the first message an application receives and it is sent only to the Application Actions section of the outline. Message Variables hWndForm None. hWndItem None. wParam None. IParam None.

SAM_CacheFull

SAM_CacheFull is sent to a table window when needs to fetch a row from the data source but the table window cache is full and none of its rows qualify as discardable. If the table window has a non-discardable cache, SAM_CacheFull indicates that no more data can fit in the table window cache. If the table window has a discardable cache, SAM_CacheFull indicates that the cache is full of data that you modified and must now save. Once you save the modified rows, they qualify as discardable. Message Variables hWndForm Handle of the table window. hWndItem None. wParam Unused. IParam Unused.

SAM_CaptionDoubleClick

SAM_CaptionDoubleClick is sent to a table window and a table window column when you double click on a table window column title. To retrieve the table window column's window handle in wParam, use Sal.NumberToWindowHandle. Message Variables hWndForm Handle of the table window. hWndItem Table window handle in table window message actions, column handle in column message actions. wParam Handle of the column. IParam Unused.

SAM_Click

In general, SAM_Click alerts an application that the user has clicked an object with the left mouse button. SAM_Click is sent to a check box or push button when you click either of these objects or perform a keyboard activity that simulates a mouse click. SAM_Click is sent to a currently-unselected radio button when you click it or perform a keyboard activity that simulates a mouse click. If the radio button you click on is already selected, no SAM_Click is sent. SAM_Click is sent to a list box when you click an entry or perform a keyboard activity that simulates a mouse click. If you click an empty list box or click a portion of the list box that contains no entries, no SAM_Click is sent. SAM_Click is sent to a combo box when you click an entry in the drop-down list box or perform a keyboard activity that simulates a mouse click. If you click the data field portion of the combo box or the button that invokes the drop-down list box, no SAM_Click is sent. SAM_Click is sent to a table window and the column with the focus when you click a table window cell or perform a keyboard activity that simulates a mouse click.

SAM_Close

SAM_Close is sent to a dialog box, a form window, MDI window, or a top-level table window when you choose the Close command from a window's system menu or when you double-click on the window's system menu. SAM_Close is sent to an application to notify the application that you are attempting to close a window. By processing the SAM_Close message, an application can check the form window or table window to see if there is data that needs to be saved to the data source. A SAM_Close message is not sent on a call to Sal.Quit, Sal.EndDialog, or Sal.DestroyWindow. If SAM_Close is sent to the Message Actions section of a modal or system modal dialog box, the application can call Sal.MessageBox to prevent the destruction of the dialog box. Otherwise, default processing closes the message box. If SAM_Close does not execute a return, the window closes; if SAM_Close returns FALSE, the window does not close. Message Variables hWndForm Window Handle of the current top-level window. hWndItem Unused. wParam Unused. lParam Unused.

SAM_ColumnSelectClick

SAM_ColumnSelectClick is sent to a table window, and a table window column when the user selects or deselects a column by clicking on the column title. You must set TBL_Flag_SelectableCols to TRUE by calling Sal.TblSetTableFlags (it is FALSE by default). To retrieve the window handle of the column in wParam, use Sal.NumberToWindowHandle. Message Variables hWndForm Window handle of the table window. hWndItem Table window handle in table window message actions, column handle in column message actions. wParam Column handle. IParam Unused.

SAM_ContextMenu

SAM_ContextMenu is sent when the user right-clicks a window or presses Shift+F10.

SAM_CornerClick

SAM_CornerClick is sent to a table window, and a table window column when you click on the title of a row header. The row header is a non-editable column on the left side of a table window. To retrieve the window handle of the column in wParam use Sal.NumberToWindowHandle. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the column. wParam Numeric value of the window handle of the column. IParam The context row of the table window.

SAM_CornerDoubleClick

SAM_CornerDoubleClick is sent to a table window, and a table window column when you double click on the title of a row header. The row header is a non-editable column on the left side of a table window To retrieve the window handle of the column in wParam, use Sal.NumberToWindowHandle. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Numeric value of the window handle of the column. IParam The context row of the table window.

SAM_CountRows

SAM_CountRows is sent to a table window that has a dynamic scroll range. Use it to query an application for the number of rows in a table window. The user scrolls to the last row in a table window (by pressing a key such as the End key). Applications process the SAM_CountRows message by returning the number of rows in the table window. Typically, this involves counting the number of rows in a result set. If an application does not process the SAM_CountRows message, SAM_FetchRow messages are used to determine the last row in a table window, namely with a TBL_NoMoreRows return from the message. Processing SAM_CountRows, however, yields better performance. Message Variables hWndForm Handle of the table window. hWndItem Handle of the table window. wParam Unused. IParam Unused. Return The number of rows in the table.

SAM_Create

SAM_Create is sent to a top-level window (dialog box, form window, or table window) and then to all of its children after they are created, but before they are made visible. It is also sent to an MDI window. For example, follow these steps to create a form window that has data fields: 1. Create the form window. 2. Create each of its data fields. After creates all the windows, but before making them visible, sends SAM_Create to the objects in this order: 1. The form window. 2. Each of the form's data fields. After sends the SAM_Create messages, makes the form window and data fields visible. By processing the SAM_Create message, an application can perform initialization tasks. Typical initialization tasks include setting data field values and populating table windows and list boxes with data from a database. Message Variables hWndForm Window handle of current top-level window. hWndItem Handle of the object being created. wParam Unused. lParam Unused.

SAM_CreateComplete

Sends SAM_CreateComplete to windows with contents (top-level windows and child table windows) after creating the window's children and displaying the window (and its children). For example, suppose you create a form window with a data field and a child table window. The child table window has one column. The following happens: 1. The form window is created. 2. The data field is created. 3. The child table window is created. 4. The child table window's column is created. Once all this is done, sends a SAM_Create message to the top-level window and all of its children. Next, makes the form window and its children visible. Finally, sends a SAM_CreateComplete message to the child table window, and then to the form window (the top-level window). By processing the SAM_CreateComplete message, you can do initialization tasks that depend on the state or contents of child windows. You can also use SAM_CreateComplete to wait to do initialization tasks until after a top-level window (and its children) has become visible. Message Variables hWndForm Window Handle of current top-level window. hWndItem Handle of the object being created. wParam Unused. lParam Unused.

SAM_CustControlCmd

Sends this message to a custom control when its parent window receives a notification (WM_COMMAND) from the custom control. Ignores any value that you Return when you process this message. Message Variables hWndForm Window handle of current top-level window. hWndItem Window handle of custom control. wParam Notification message number. IParam Unused.

SAM_DDE_ClientExecute

SAM_DDE_ClientExecute is sent to all objects in a server application. The event that causes it is a DDE client sent a command string. A server listens for command requests from clients by processing SAM_DDE_ClientExecute. The server gets the command string that the client sent by calling Sal.DDEGetExecuteString. The parameter for Sal.DDEGetExecuteString is the lParam of the SAM_DDE_ClientExecute message, which points to the command string. After calling Sal.DDEGetExecuteString, the server can parse the command string to determine the action to perform. The server can send data or some other response to the client by calling Sal.DDESendToClient. The wParam for the SAM_DDE_ClientExecute message contains the window handle of the client. The server uses wParam in the third parameter of Sal.DDESendToClient to send the data or response back to the same client. Message Variables hWndForm Handle of a top-level window. hWndItem Object handle. wParam Window handle of sender. lParam Command string.

SAM_DDE_ClientRequest

SAM_DDE_ClientRequest is sent to a server application as the result of a client application's request for updated data. A server listens for requests from clients by processing the SAM_DDE_ClientRequest message. A server sends data to a client by calling Sal.DDESendToClient. The wParam for the SAM_DDE_ClientRequest message contains the window handle of the client. The server uses wParam in a Sal.DDESendToClient parameter to send the data back to the same client. Message Variables hWndForm Handle of a top-level window. hWndItem Object handle. wParam Window handle of the sender. IParam Unused.

SAM_DDE_DataChange

SAM_DDE_DataChange is sent to all objects in a DDE client application. It is sent when a DDE server has sent data to the client. When a DDE server sends an item to the client, the data appears automatically in the window that the client specified in Sal.DDEStartSession. The client application does not need to perform any action to receive the data. However, if the client application wants to know when the server sends an item, it can process the SAM_DDE_DataChange message. Note that SAM_DDE_DataChange is sent after the server sends the data to the client. Message Variables hWndForm Handle of a top-level window. hWndItem Object handle. wParam Unused. IParam Unused.

SAM_Destroy

SAM_Destroy is sent to a top-level window (dialog box, form window, or table window) and then to all of its children just before the windows are destroyed. SAM_Destroy messages are sent after SAM_Close has been sent to the top-level window. For example, if a form window has data fields, sends the messages to the objects in this order: SAM_Close to the form window. SAM_Destroy to the form window. SAM_Destroy to each of the form window's child windows. After all of the SAM_Destroy messages are sent, the top-level and child windows are destroyed. It is also sent to an MDI window. sends SAM_Destroy to an MDI window and its children in this order: MDI window Form window or table window Form window or table window children and grandchildren (columns) Form window or table window toolbar children and grandchildren MDI window toolbar children and grandchildren Message Variables hWndForm Window handle of current top-level window. hWndItem Window handle of object being destroyed. wParam Unused. lParam Unused.

SAM_Dock

SAM_Dock is sent to a docking host (top-level window) when a docking dialog is about to change its docking orientation.

SAM_DockChange

SAM_DockChange is sent to a docking dialog box after it has changed its docking orientation.

SAM_DoubleClick

SAM_DoubleClick is sent to a combo box, list box, picture, table window, or a column when you double-click on one of these objects. When the user double-clicks a row in a table window or list box, sends the messages in this order: 1. Two SAM_Click messages. 2. SAM_DoubleClick to the table window column or list box. 3. SAM_DoubleClick to the table window. A double-click can select a row in a list box or table window and then start an action for that row. For example, a list box can contain a list of file names. When the user double-clicks a name in the list box, the application opens the file. SAM_DoubleClick is only sent to a combo box if Always Show List is set to Yes. Message Variables For a combo box or list box: hWndForm Handle of form window or dialog box. hWndItem Window handle of the combo box or list box. wParam Unused. IParam Unused. For a picture: hWndForm Handle of form window or dialog box. hWndItem Window handle of the picture. wParam The X coordinates in the picture at the point where the user double-clicked. lParam The Y coordinates in the picture at the point where the user double-clicked. For a table window: hWndForm Window handle of the table window. hWndItem Window handle of the column. wParam Unused. lParam Row number in the table window. For a column: hWndForm Window handle of the table window. hWndItem Window handle of the column. wParam Unused. lParam RowNumber in the table window.

SAM_DragCanAutoStart

SAM_DragCanAutoStart is sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture. Sends this message to ask a window whether it wants auto dragging. Return TRUE to enable auto dragging. If you do not process this message or you return FALSE, then does not enable auto dragging. Starts drag mode automatically when the application returns TRUE from SAM_DragCanAutoStart. This is the minimum that an application does to let a user drag from a window. However, you must write additional code to do something when the user drops in a window. Message Variables hWndForm Handle of top-level window. hWndItem Window handle of the source window. wParam Position of the mouse on the X axis. IParam Position of the mouse on the Y axis.

SAM_DragDrop

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture. Sent when the user drops the mouse on a target window. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Window handle of the source window. IParam Unused.

SAM_DragEnd

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that drag mode has ended. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Unused. IParam Unused.

SAM_DragEnter

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that the mouse has moved into the window while in drag mode. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Window handle of the source window. IParam Unused.

SAM_DragExit

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that the mouse has moved off of the window while in drag mode. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Window handle of the source window. IParam Unused.

SAM_DragMove

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that the mouse has moved onto the window while in drag mode. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Window handle of the source window. IParam Unused.

SAM_DragNotify

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that a mouse action occurred while in drag mode. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam Window handle of the target window. IParam One of the following messages: SAM_DragDrop - The user moved the mouse into a target window. SAM_DragEnter - The user dropped the mouse in a target window. SAM_DragExit - The user moved the mouse out of the target window. SAM_DragMove - The user moved the mouse within a target window.

SAM_DragStart

Sent to a top-level window, child table window, data field, multi line field, list box, combo box, and picture, indicating that drag mode has started. Message Variables hWndForm Handle of top-level window. hWndItem Handle of object receiving message. wParam The position of the mouse on the X axis. IParam The position of the mouse on the Y axis.

SAM_DropDown

SAM_DropDown is sent to a combo box before the list box portion of the combo box drops down. This message does not occur unless the Drop Down item is set to Yes. Message Variables hWndForm Window handle of the form window or dialog box. hWndItem Window handle of the combo box. wParam Unused. IParam Unused.

SAM_DropFiles

Sent to a column, data field, multi line field, list box, combo box, picture, custom control. Only sends this message to windows that have enabled file dropping. It is sent when the user drops a file or files from Explorer or File Manager on the object. Call the Sal.DropFilesQueryFiles function to get the names of the files dropped on the object. Sal.DropFilesQueryFiles returns the number of files that were dropped or 0 if the function fails. You can only call Sal.DropFilesQueryFiles during SAM_DropFiles message processing. Call the Sal.DropFilesQueryPoint function to get the location of the mouse in the window where the user dropped the file or files. By default, file dropping is enabled for editable picture objects. To avoid this default processing, execute a Return statement in the SAM_DropFiles message processing for a picture object and do not perform any other processing. For example, when a user drops on a picture, you can call Sal.DropFilesQueryFiles or Sal.DropFilesQueryPoint in the SAM_DropFiles message processing and decide whether to process what the user is dropping or to ignore it by executing a Return statement with no other processing. You can completely disable file dropping for an editable picture by calling the Sal.DropFilesAccecptFiles function. The default for editable picture windows is TRUE. The default for all other window types is FALSE. Message Variables hWndForm Handle of top-level window. hWndItem Handle of the object receiving the message. wParam Unused. lParam Unused.

SAM_EndCellTab

Sends this message to a table window when the user tries to tab past the last editable cell. You can use this message to automate row insertion. When the window receives this message, add a blank row to the window. By default, this message returns FALSE, which selects the current row. Return TRUE to prevent this behavior. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Unused. IParam Table window context row that the user is trying to tab away from (first row is 0, second row is 1, and so on)

SAM_FetchDone

SAM_FetchDone is sent to a table window when Sal.TblPopulate, using the TBL_FillAllBackground value as its last parameter, completes the population of a table window Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Unused. IParam Unused.

SAM_FetchRow

SAM_FetchRow is sent to a table window whenever needs to copy a row into the table window cache. When you populate a table window, sends a SAM_FetchRow message for every row in the table window that displays. When the user scrolls forward, sends more SAM_FetchRow messages to the table window for those rows not currently in the cache that need to be displayed. You usually call Sql.FetchRow to fetch a row into the table window based on the row number in lParam. Note: Setting a breakpoint on a statement that executes while processing a SAM_FetchRow message can cause incomplete painting of a table window. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Unused. IParam Row number of row that was populated. Return One of three possible values: TBL_NoMoreRows - There are no rows at the specified fetch number and beyond. TBL_RowDeleted - The row has been deleted. TBL_RowFetched - The row was fetched successfully.

SAM_FetchRowDone

SAM_FetchRowDone is sent to a table window after populates a row. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Unused. lParam Row number of the fetched row.

SAM_FieldEdit

SAM_FieldEdit is sent to a combo box, data field, multi line text field, table window, or table window column when you change a window's value and then move the focus away from that window. For example, if you enter a value into a data field, then press the TAB key or click the mouse to move to another field, a SAM_FieldEdit message is sent to the data field. The SAM_FieldEdit message is different from the SAM_AnyEdit message. A SAM_AnyEdit message is sent for every keystroke, while a SAM_FieldEdit message is sent only when you attempt to leave a window whose value you changed. Use SAM_Validate for field validation. SAM_Validate supersedes SAM_FieldEdit.

SAM_Help

SAM_Help is sent to any top level window and MDI window when the user presses the F1 function key. It is used in conjunction with Sal.WinHelp to call up a user-created Help system. The wParam contains the handle of the child object that has the focus that you can use for a context-sensitive help system. Message Variables hWndForm Window handle of the current form window or table window. hWndItem Window handle of the current form window or table window. wParam Window handle of the child window that has the focus. IParam Unused.

SAM_ItemClicked

SAM_ItemClicked is sent when the user click a node in a SalTreeControl control. wParam is the item handle. lParam is not used.

SAM_ItemCollapsed

SAM_ItemCollapsed is sent when the user collapses a node in a SalTreeControl control. wParam is the item handle. lParam is not used.

SAM_ItemExpanded

SAM_ItemExpanded is sent when the user expands a node in a SalTreeControl control. wParam is the item handle. lParam is not used.

SAM_ItemSelected

SAM_ItemSelected is sent when the user select a node in a SalTreeControl control. wParam is the item handle. lParam is not used.

SAM_KillFocus

SAM_KillFocus is sent to a table window, data field, multi line field, pushbutton, radio button, check box, option button, combo box, list box, column, and horizontal and vertical scroll bar as you are about to exit the object. The message is always sent whether or not you changed the object's value. Warning: You cannot call Sal.SetFocus in SAM_KillFocus processing because of a Windows limitation. Message Variables hWndForm Window handle of the top-level window. hWndItem Window handle of the object. wParam Handle of the window gaining the focus. IParam Unused.

SAM_NavChange

SAM_NavChange is sent when a pane becomes active (i.e. displayed or selected).

SAM_NavGroupCollapse

SAM_NavGroupCollapse is sent when a group (within a pane, delimited by a pane separator) is collapsed. wParam The index of the pane where is the group is located. lparam The index of the group which is being collapsed.

SAM_NavGroupExpand

SAM_NavGroupExpand is sent when a group (within a pane, delimited by a pane separator) is expanded. wParam The index of the pane where is the group is located. lParam The index of the group which is being expanded.

SAM_NavResize

SAM_NavResize is sent when the splitter is moved to a new position. wParam The index of the pane which is being resized. lParam The size of the object after resizing. The low-order word contains the width in pixels, and the high-order word contains the height in pixels.

SAM_Print

SAM_Print is sent to a form window, data field, multi line text field, combo box, or push button while the object prints.

SAM_ReportFetchInit

Sent to a top-level window or MDI window that started a report. Happens when the first page of a report is ready for formatting. It sends SAM_ReportFetchInit after sending SAM_ReportStart. SAM_ReportFetchInit means that it is ready to receive data from the application. If the report contains data from a database, call SqlExecute. If Sql.Execute returns TRUE, then Return TRUE. If you Return FALSE, the report stops. If you do not Return a value, or you do not process the message, the report continues. Message Variables hWndForm Unused. hWndItem Unused. wParam Window handle of a report window. IParam Unused.

SAM_ReportFetchNext

SAM_ReportFetchNext message is send to a top-level window or MDI window that started the report. This message is sent after a SAM_ReportFetchInit message to indicate that it is ready to receive the next row of data from the application. If the application is going to fetch the report data from a database, it typically makes a call to Sql.FetchNext to fetch the next row from the database upon receipt of this message. If the fetch is successful, the application returns TRUE for SAM_ReportFetchNext. Does not send data from the application to the report until the application returns TRUE in SAM_ReportFetchNext processing. If there is no more data to fetch, the application returns FALSE. Message Variables hWndForm Unused. hWndItem Unused. wParam Window handle of the window that started the report. IParam Unused.

SAM_ReportFinish

SAM_ReportFinish message is sent to a top-level window or MDI window that started the report. SAM_ReportFinish is sent when the report finishes. The application can use this message to do any sort of cleanup that is needed following the generation of a report. Message Variables hWndForm Unused. hWndItem Unused. wParam Window handle of the window that started the report. IParam TRUE, if the user has canceled printing the report.

SAM_ReportNotify

Data is fetched and blocks of the report are formatted. When the formatted blocks cross a page boundary, a page header/footer block set is inserted in the flow and the page is sent to the printer or displayed in preview mode. The report sends SAM_ReportNotify messages as the report blocks are formatted and output into the page buffer. The Before notifications are send before any formatting occurs, the Output notifications are sent when the first line of the report is output and the Done notifications are sent when the entire block is output. Notifications are sent to a top-level window or MDI window that starts the report. Two sets of notifications are sent for each block: When at least one line of the formatted block is output | When the block is finished outputting Check the lParam variable to see which part of the report is ready to be formated. The lParam is one of the RPT_Before* constants. Any value that you return during SAM_ReportNotify processing is ignored

SAM_ReportStart

Sent to a top-level window or MDI window that started a report when a part of a report is ready to be formatted. SAM_ReportStart is sent after the application calls the report with either Sal.ReportView or Sal.ReportPrint to indicate that the report is starting. SAM_ReportStart is sent before the report displays or prints. You can use SAM_ReportStart to do any sort of initialization necessary before sending data to the report. Ignores SAM_ReportStart's return value. Message Variables hWndForm Unused. hWndItem Unused. wParam Window handle of the window that started the report. IParam Unused.

SAM_RowHeaderClick

SAM_RowHeaderClick is sent to a table window when you click on a row in the row header. This message is not sent unless Sal.TblDefineRowHeader has been used to define a row header. Message Variables hWndForm Window handle of the table window. hWndItem Window Handle of the table window. wParam Unused. IParam Context row of the table window.

SAM_RowHeaderDoubleClick

SAM_RowHeaderDoubleClick is sent to a table window when you double-click on a row in the row header. Only sends this message when TBL_RowHdr_Visible is TRUE (which is the default). If TBL_RowHdr_Visible is FALSE, you can set it to TRUE by calling Sal.TblDefineRowHeader. Message Variables hWndForm Window handle of the table window. hWndItem Window Handle of the table window. wParam Unused. lParam Context row of the table window

SAM_RowSetContext

Sends this message to a TableWindow when the user changes its focus row. If you process this message but do not execute a Return statement, performs its default processing. Message Variables hWndForm Window handle of the top-level window. hWndItem Window handle of the object. wParam Unused. lParam Unused.

SAM_RowValidate

SAM_RowValidate is sent to a table window before the table window's focus row changes, letting the application validate the contents of the row. The SAM_RowValidate message is sent regardless of the current row flags or cell edited flags. It is sent only when you change the focus row, not when you remove the focus from the table window. If the application returns VALIDATE_Cancel, the focus remains on the current row. If the application returns VALIDATE_Ok, the table window behaves as normal and changes the focus row. Message Variables hWndForm Window handle of the table window. hWndItem Window handle of the table window. wParam Unused. lParam Table window context row (first row is 0, second row is 1, and so on).

SAM_ScrollBar

SAM_ScrollBar is sent to a horizontal or vertical scroll bar when you move within the scroll bar using either the mouse or the keyboard. The application must check SAM_ScrollBar's wParam variable in order to determine which of the following movements occurred: SB_Bottom SB_LineDown SB_LineUp SB_PageDown SB_PageUp SB_ThumbPosition SB_ThumbTrack SB_Top

SAM_SetFocus

SAM_SetFocus is sent to a check box, combo box, data field, list box, multi line text field, push button, radio button, scroll bar, or table window column when it receives the input focus. Process the SAM_SetFocus message and initialize actions to take place when the user enters an object. Avoid calling functions that can change the focus (such as Sal.MessageBox, Sal.ModalDialog, Sal.SendMsg) while processing a SAM_SetFocus message. Message Variables hWndForm Window handle of the top-level window. hWndItem Window handle of the object receiving the message. wParam Handle of the window losing the focus. lParam Unused.

SAM_SqlError

Sent to the Application Actions section of the outline when a SQL function fails. If you process this message, you can control how the application responds to SQL errors on a global level instead of using the default error processing which displays a dialog box with the error number and error text. Call Sql.ExtractArgs to get the error code, error position, and Sql Handle from the wParam and lParam. You can also use When SqlError in any actions section of the outline to process an error at a local level. Message Variables hWndForm Always hWndNULL. hWndItem Not used. wParam Sql Handle. lParam SQL Error code and position

SAM_TabChange

This message is fired when the user navigates to a different tab page in a tab control. wParam = Index of the formerly active tab page. lParam = Index of the newly activated tab page. Return False to prevent the tab control from switching the active tab.

SAM_TblDoDetails

Sends this message to a table window when the user or code changes its focus row. If you process this message but do not execute a Return statement, performs its default processing. Message Variables hWndForm Window handle of the top-level window. hWndItem Window handle of the object. wParam Unused. IParam Unused.

SAM_Timer

Sent to the Application Actions, top-level window and its children, MDI window every n milliseconds, as specified by Sal.TimerSet. Check the wParam to find the identifier of the timer that sent the message. This way, one object can process SAM_Timer messages from more than one timer. Important: Timers are a limited resource in Windows, so use them sparingly. Message Variables hWndForm Window handle of the top-level window. hWndItem Window handle of the object receiving the message. wParam Timer ID. IParam Unused.

SAM_User

This constant represents the value at which user-defined messages should start. The next consecutive user-defined message would be SAM_User+1.

SAM_Validate

Sent to a Data field, multi line field, combo box, and column when the user changes the value of the object and then moves the focus away from the object. The user can move the focus by several actions such as tabbing to another object, clicking another object, or using a mnemonic or accelerator to activate another object. When a user changes one of these objects, the object's field edit flag changes to TRUE. You can get and set the field edit flag using Sal.QueryFieldEdit and Sal.SetFieldEdit. SAM_Validate validates the data that the user entered or changed. Whenever the user changes an object, sends SAM_Validate. If an object is valid, return VALIDATE_Ok. The value you return from SAM_Validate processing controls whether the focus changes. Does not send SAM_Validate when the user selects a menu item (a menu selection does not change the focus). You can force to send SAM_Validate by calling Sal.SendValidateMsg by calling Sal.SendValidateMsg in the menu actions of a menu item. This forces field validation before processing a menu selection (without changing the focus). Sal.SendValidateMsg returns the value that the SAM_Validate message processing returns. To Control the action that happens return one of these values: VALIDATE_Cancel, VALIDATE_Ok or VALIDATE_OkClearFlag. Note: Unless you return VALIDATE_Cancel SAM_FieldEdit will also be send to the object.

SAM_XMLRowDone

This message is sent to a table window when a new row of data has just been added to that table window during a call to Sal.TblPopulateFromXML(). hWnForm: Handle of the table window. hWndItem: Handle of the table window. WParam: Unused. lParam: Row number of the populated row.

SB_Bottom

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you have scrolled to the scroll bar's end (maximum).

SB_LineDown

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you have scrolled to the scroll bar's end (maximum).

SB_LineUp

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you have scrolled one line more.

SB_PageDown

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you have scrolled one page less.

SB_PageUp

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you have scrolled one page more.

SB_ThumbPosition

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you dragged the scroll box to a new position within the scroll bar. Specify SB_ThumbPosition if you want the client area repainted when you release the Thumb. (Compare to SB_ThumbTrack).

SB_ThumbTrack

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you dragged the scroll box to a new position. Specify SB_ThumbTrack if you want the client area updated every time you click on and drag the thumb of the scroll bar. (Compare to SB_ThumbPosition).

SB_Top

The SAM_ScrollBar message sends this constant (as the wParam variable) to indicate that you scrolled to the beginning (minimum) of the scroll bar.

SQLERROR_Reason

When calling Sql.ErrorText, set the nType parameter to this constant to retrieve the error reason.

SQLERROR_Remedy

When calling Sql.ErrorText, set the nType parameter to this constant to retrieve the error remedy.

strArgArray

This is a dynamic array which contains the command line arguments.

STRING_Null

Use this constant to set a String to a null value or to check if a String value is a null.

TBL_Adjust

Sal.TblDeleteRow uses this constant to coordinate the deletion of a table window row with the deletion of a row from the underlying result set. TBL_Adjust ensures automatic correspondence between the lParam (selected row) of the SAM_FetchRow message and the row number in the result set. It automatically re-synchronizes the row number in the result set with the row number in the table window. Using TBL_Adjust prevents blank rows in the table window. When the user deletes with TBL_Adjust the row number is remembered. All actions with the table, fetching, row context, row searching then adjusts the row number to be insync with the sql result set row number hiding those that are deleted. If you were to just delete from the result set, the next time that table row were asked to fetch it's returns would be null (deleted).

TBL_AutoScroll

The Sal.TblScroll function uses this constant to scroll the table window to the specified row and column. TBL_AutoScroll scrolls the table window as needed until the row becomes visible. This is the default and only behavior supported by the Sal.TblScroll function.

TBL_Error

Returns this constant when a table window function is unsuccessful.

TBL_FillAll

The Sal.TblPopulate function uses this constant to populate an entire table window at once.

TBL_FillAllBackground

The Sal.TblPopulate function uses this constant to populate the visible portion of a table window first, then return control to the application and continue fetching rows in the background. Fetches subsequent rows at a rate of one row every 1/4 of a second. Once all rows have been fetched, the table window receives a SAM_FetchDone message.

TBL_FillNormal

The Sal.TblPopulate function uses this constant to populate the visible portion of the table window first, then populates new rows as they are scrolled into view.

TBL_Flag_EditLeftJustify

This flag instructs to left-justify cells while they are being edited. By default, cell editing behavior reflects the column definition. For example, when you edit a right-justified column, right- justifies the text. With center-justified and right-justified columns, this means that you are not able to enter more text than fits in the cell. Use TBL_Flag_EditLeftJustify with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_GrayedHeaders

This flag instructs to paint column headings and row headings with color and shading similar to push buttons. Use TBL_Flag_GrayedHeaders with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_HideColumnHeaders

This flag instructs hides the column headers. Use TBL_Flag_HideColumnHeaders with the SalTblQueryTableFlags and SalTblSetTableFlags functions.

TBL_Flag_HScrollByCols

Not supported.

TBL_Flag_MovableCols

This flag lets the user drag-move columns. Use TBL_Flag_MoveableCols with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_SelectableCols

This flag lets the user select columns by clicking the column title. Use TBL_Flag_SelectableCols with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_ShowVScroll

Not supported.

TBL_Flag_ShowWaitCursor

Not supported.

TBL_Flag_SingleSelection

This flag ensures that the user can only select one row at a time from a table window. Use TBL_Flag_SingleSelection with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_SizableCols

This flag lets the user drag-size columns. Use TBL_Flag_SizableCols with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_SuppressLastColLine

This flag suppresses painting of the dotted lines that separate columns. Use TBL_Flag_SuppressRowLines with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_Flag_SuppressRowLines

This flag suppresses painting of the dotted lines that separate rows. Use TBL_Flag_SuppressRowLines with the Sal.TblQueryTableFlags and Sal.TblSetTableFlags functions.

TBL_MaxRow

This constant represents the maximum or last row in a table window. Use it with the Sal.TblSetRange (to define a dynamic scroll range), Sal.TblFindPrevRow (to find the last row in a table), and Sal.TblInsertRow functions.

TBL_MinRow

This constant represents the minimum or first row in a table window. Use it with the Sal.TblFindNextRow (to find the first row in a table), Sal.TblInsertRow and Sal.TblSetRange functions.

TBL_MinSplitRow

This constant identifies the minimum row number of a row in the lower half of a split window. For example, you can use it with the Sal.TblSetFocusRow function to set the focus to the first row in the lower half of a split window.

TBL_NoAdjust

The Sal.TblDeleteRow function uses this constant to coordinate the deletion of a table window row with the deletion of a row from the underlying result set. TBL_NoAdjust does not re-synchronize the row number of the row in the result set with the row number of the row in the table window. When you delete a row from a table window, a blank row displays in its place. When the user deletes with TBL_NoAdjust it simply deletes that row number, all rows above (higher) the deleted are now one less, that is not adjusted for the result set. The row number is not going to be in sync with a result set now. A side effect of this is that if you get a fetch message for the row number that was deleted your code will get called and null values will be returned (the result set row is deleted).

TBL_NoMoreRows

This constant is returned to the Sal.TblFetchRow function when can not fetch the specified row and there are no more rows to fetch after the specified row.

TBL_RowDeleted

This constant is returned to the Sal.TblFetchRow function when can not fetch the specified row because another transaction deleted it.

TBL_RowFetched

This constant is returned to the Sal.TblFetchRow function when the row is successfully fetched.

TBL_RowHdr_MarkEdits

This flag displays a symbol in the edit indicator column of a row that means the setting of the row flag: A check mark means that the row has been modified (ROW_Edited). An X means that the row is marked for deletion (ROW_MarkDeleted). A right arrow means that this is a new row ( ROW_New). Use TBL_RowHdr_MarkEdits with the Sal.TblDefineRowHeader and Sal.TblQueryRowHeader functions.

TBL_RowHdr_RowsSizable

This flag lets the user drag-size the row height. Use TBL_RowHdr_RowsSizable with the Sal.TblDefineRowHeader and Sal.TblQueryRowHeader functions.

TBL_RowHdr_ShareColor

This flag sets the row header color to the text color of the cells in hWndCol. Otherwise, the row header uses the table window's default text color. Use TBL_RowHdr_ShareColor with the Sal.TblDefineRowHeader and Sal.TblQueryRowHeader functions.

TBL_RowHdr_Sizable

This flag lets the user drag-size the row header. Use TBL_RowHdr_Sizable with the Sal.TblDefineRowHeader and Sal.TblQueryRowHeader functions.

TBL_RowHdr_Visible

This flag makes the row header visible. Use TBL_RowHdr_Visible with the Sal.TblDefineRowHeader and Sal.TblQueryRowHeader functions.

TBL_ScrollBottom

The Sal.TblScroll function uses this constant to describe the position of the row to which you are scrolling. TBL_ScrollBottom scrolls the row to the bottom of the table window.

TBL_ScrollTop

The SalTblScroll function uses this constant to describe the position of the row to which you are scrolling. TBL_ScrollTop scrolls the row to the top of the table window.

TBL_SetFirstRow

This constant is used by Sal.TblSetRow to change the current focus row in a table window to the first row.

TBL_SetLastRow

This constant is used by Sal.TblSetRow to change the current focus row in a table window to the last row.

TBL_SetNextRow

This constant is used by Sal.TblSetRow to change the current focus row in a table window to the next row.

TBL_SetPrevRow

This constant is used by Sal.TblSetRow to change the current focus row in a table window to the previous row.

TBL_SortDecreasing

You specify this constant for Sal.TblSortRows when you want to sort the table window rows in descending order.

TBL_SortIncreasing

You specify this constant for Sal.TblSortRows when you want to sort the table window rows in ascending order.

TBL_Split_Adjustable

Not supported.

TBL_TempRow

This constant represents a temporary row that you can use with the SalTblSetContext function to move the context away from a table window row. You can also use it with the Sal.TblQueryContext function.

TBL_XOverLockedColumns

Sal.TblObjectsFromPoint returns this constant when the X coordinate is in a locked column.

TBL_XOverLockedColumnsBorder

Sal.TblObjectsFromPoint returns this constant when the X coordinate is between a locked column and an unlocked column.

TBL_XOverRowHeader

Sal.TblObjectsFromPoint returns this constant when the X coordinate is in a row header.

TBL_XOverUnlockedColumns

Sal.TblObjectsFromPoint returns this constant when the X coordinate is in an unlocked column.

TBL_YOverColumnHeader

Sal.TblObjectsFromPoint returns this constant when the Y coordinate is in a column header.

TBL_YOverNormalRows

Sal.TblObjectsFromPoint returns this constant when the Y coordinate is in a row in the upper part of a split table window or in a row in a non-split table window.

TBL_YOverSplitBar

Not supported.

TBL_YOverSplitRows

Not supported.

TPM_CenterAlign

Use this constant with Sal.TrackPopupMenu to center-align the pop-up menu.

TPM_ContextMenu

Use this flag with Sal.TrackPopupMenuwhen displaying a popup menu in response to SAM_ContextMenu. This flag sets the focus to the window specified in Sal.TrackPopupMenu and displays the popup left aligned with the horizontal screen coordinate.

TPM_CursorX

Use this constant with Sal.TrackPopupMenu to tell to use the mouse cursor location instead of nX.

TPM_CursorY

Use this constant with Sal.TrackPopupMenu to tell to use the mouse cursor location instead of nY.

TPM_LeftAlign

Use this constant with Sal.TrackPopupMenu to left-align the pop-up menu (default) to its horizontal screen coordinate. This coordinate identifies the cursor location, or the point specified by nX/nY.

TPM_LeftButton

Use this constant with Sal.TrackPopupMenu to establish the left mouse button as the one with which to click on menu items (default).

TPM_RightAlign

Use this constant with Sal.TrackPopupMenu to right-align the pop-up menu to its horizontal screen coordinate. This coordinate identifies the cursor location, or the point specified by nX/nY.

TPM_RightButton

Use this constant with Sal.TrackPopupMenu to establish the right mouse button as the one with which to click on menu items.

TRACE_Event

trace event viewer

TRACE_File

Trace file

TRACE_Output

Trace output

TRACE_stdout

trace stdout

TraceApplication

Application trace

TraceFiles

Files trace

TraceReports

Reports trace

TraceSQL

SQL trace

TraceSystem

System trace

TraceTableWindow

TableWindow trace

TraceWindows

Window trace

TYPE_AccFrame

Use this constant to specify that a child window’s object type is an accessory frame.

TYPE_ActiveX

Use this constant to specify that a child window's object type is an ActiveX control.

TYPE_Any

Use this constant to specify the first child window of any type. Use TYPE_Any with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_BkgdText

Use this constant to specify that a child window's object type is label control. Use TYPE_BkgdText with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_CheckBox

Use this constant to specify that a child window's object type is check box. Use TYPE_CheckBox with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_ChildGrid

Not supported.

TYPE_ChildTable

Use this constant to specify that a child window's object type is child table window. Use TYPE_ChildTable with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_ComboBox

Use this constant to specify that a child window's object type is combo box. Use TYPE_ComboBox with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_CustControl

Use this constant to specify that a child window's object type is custom control. Use TYPE_CustControl with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_DataField

Use this constant to specify that a child window's object type is data field. Use TYPE_DataField with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_DatePicker

This constant specifies that a child window's object type is a date picker control. The VisCalendar control used to return TYPE_CustControl, it now returns TYPE_DatePicker.

TYPE_DateTimePicker

This constant specifies that a child window's object type is a date picker control. The VisCalendarDropDown control used to return TYPE_CustControl, it now returns TYPE_DateTimePicker.

TYPE_DialogBox

Use this constant to specify that a window's object type is dialog box. Use TYPE_DialogBox with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_FormToolBar

Use this constant to specify that a child window's object type is form tool bar. Use TYPE_FormToolBar with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_FormWindow

Use this constant to specify that a window's object type is form window. Use TYPE_FormWindow with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_Frame

Use this constant to specify that a child window's object type is frame. Use TYPE_Frame with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_GridWindow

Not supported.

TYPE_GroupBox

Use this constant to specify that a child window's object type is group box. Use TYPE_GroupBox with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_HorizScrollBar

Use this constant to specify that a child window's object type is horizontal scroll bar. Use TYPE_HorizScrollBar with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_Line

Use this constant to specify that a child window's object type is line. Use TYPE_Line with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_ListBox

Use this constant to specify that a child window's object type is list box. Use TYPE_ListBox with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_MDIWindow

Use this constant to specify that a window's object type is MDI window. Use TYPE_MDIWindow with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_MultilineText

Use this constant to specify that a child window's object type is multi-line text field. Use TYPE_MultilineText with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_NavBar

This constant specifies that a child window's object type is a navigation bar. Use with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_NavPane

This constant specifies that a child window's object type is a navigation pane inside a navigation bar. Use with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_OptButton

Use this constant to specify that a child window's object type is option button. Use TYPE_OptButton with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_Picture

Use this constant to specify that a child window's object type is picture. Use TYPE_Picture with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_PushButton

This constant specifies that a child window's object type is push button. Use TYPE_PushButton with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_RadioButton

This constant specifies that a child window's object type is radio button. Use TYPE_RadioButton with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_RichTextControl

This constant specifies that a child window's object type is a rich text edit control. The VisRichEdit control used to return TYPE_CustControl, it now returns TYPE_RichTextControl.

TYPE_TabBar

This constant specifies that a child window's object type is a tab bar. Use with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_TableColumn

This constant specifies that a child window's object type is table window column. Use TYPE_TableColumn with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_TableWindow

This constant specifies that a window's object type is table window. Use TYPE_TableWindow with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

TYPE_TreeControl

This constant specifies that a child window's object type is a tree control.

TYPE_VertScrollBar

This constant specifies that a child window's object type is vertical scroll bar. Use TYPE_VertScrollBar with the Sal.GetFirstChild, Sal.GetNextChild, and Sal.GetType functions.

VALIDATE_Cancel

This constant indicates that validation of the contents of a data field, multi line text field, combo box, or table window column failed. Focus returns to the edited object. VALIDATE_Cancel is one of three possible return values from the SAM_Validate and SAM_RowValidate messages. It is also one of two possible return values from the Sal.SendValidateMsg message.

VALIDATE_Ok

This constant indicates that some user action took place and that the focus moved from the edited object. Examples of user action include tabbing to another object, using the mouse to click on another object, or using a mnemonic or accelerator to activate another object. VALIDATE_Ok is one of three possible return values from the SAM_Validate and SAM_RowValidate messages. It is also one of two possible return values from the Sal.SendValidateMsg message. Performs its own validation if you do not trap and process the SAM_Validate message.

VALIDATE_OkClearFlag

This constant indicates that some user action took place and that cleared the field edited flag. VALIDATE_OkClearFlag is one of three possible return values from the SAM_Validate and SAM_RowValidate messages.

VT_BOOL

VT_BSTR

VT_CY

VT_DATE

VT_DECIMAL

VT_DISPATCH

VT_EMPTY

VT_ERROR

VT_I1

VT_I2

VT_I4

VT_R4

VT_R8

VT_UI1

VT_UI2

VT_UI4

VT_UNKNOWN

VT_VARIANT

VT_VOID

Window_Invalid

The Sal.GetWindowState function returns this constant when the specified window handle is not valid.

Window_Maximized

The Sal.GetWindowState function returns this constant when the specified window is maximized. You can also specify this constant when you call the Sal.LoadAppAndWait function.

Window_Minimized

The Sal.GetWindowState function returns this constant when the specified window is minimized (iconic). You can also specify this constant when you call the Sal.LoadAppAndWait function.

Window_Normal

The Sal.GetWindowState function returns this constant when the specified window exists on the screen and is neither maximized nor minimized. You can also specify this constant when you call the Sal.LoadAppAndWait function.

Window_NotVisible

The Sal.GetWindowState function returns this constant when the specified window is not visible on the screen. You can also specify this constant when you call the Sal.LoadAppAndWait function.

WM_DDE_Ack

WM_DDE_Advise

WM_DDE_Data

WM_DDE_Execute

WM_DDE_First

WM_DDE_Initiate

WM_DDE_Poke

WM_DDE_Request

WM_DDE_Terminate

WM_DDE_Unadvise

wParam

The wParam value used in the last message.

XML_DocAndSchema

Causes both the XML document and the schema files to be written.

XML_Document

Causes only the XML document to be written.

XML_Schema

Causes only the XML schema to be written.

Properties

CultureInfo: Returns the current CultureInfo.

Methods

Reads the protected HResult property.

ParameterTypeDescription

ex

Returns: Int32.

Logs the call to a method that is not yet implemented.

Logs the call to a method that is not supported.

Logs an error

ParameterTypeDescription

traceswitch

text

args

Logs an exception

ParameterTypeDescription

traceswitch

e

level

Logs an information

ParameterTypeDescription

traceswitch

text

args

Logs extra information

ParameterTypeDescription

traceswitch

text

args

Logs a warning

ParameterTypeDescription

traceswitch

text

args

Last updated