Vis
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Web.Vis.50 (5.0.0.0)
Provides Visual Toolchest compatibility functions for arrays, files, strings, lists, menus, and windows.
- C#
- VB.NET
public class Vis
Public Class Vis
Many functions use zero for success and negative VTERR_* values for failure. Check the individual return contract; Boolean and item-index functions use different conventions.
Example:
using PPJ.Runtime;
using PPJ.Runtime.Vis;
SalString result = Vis.StrChoose(true, "Enabled", "Disabled");
SalNumber flags = 0;
Vis.NumberBitSet(ref flags, 4);
Fields
| Name | Type | Description | Value |
|---|---|---|---|
| ACTION_Abort | Int32 | Error action code indicating the error handler should abort the operation. | 2 |
| ACTION_Retry | Int32 | Requests that an operation be retried after error recovery. | 1 |
| CAL_AlternateButtons | Int32 | Calendar style flag for alternate navigation-button placement. | 0x1000 |
| CAL_EnableButtons | Int32 | Compatibility style flag that enables the previous/next navigation buttons on a VisCalendar. | 0x0004 |
| CAL_EnableKeyboard | Int32 | Compatibility style flag that enables keyboard navigation on a VisCalendar. | 0x0008 |
| CAL_EtchedLook | Int32 | Compatibility style flag that draws the calendar with an etched (sunken) border look. | 0x0010 |
| CAL_MultiSelect | Int32 | Compatibility style flag that allows multiple dates to be selected on a VisCalendar. | 0x0020 |
| CAL_SelectExtra | Int32 | Compatibility style flag that allows selecting days from the previous/next month shown at the edges of the grid. | 0x0040 |
| CAL_SelectSpecial | Int32 | Compatibility style flag that allows selecting days marked as special. | 0x0080 |
| CAL_ShowExtra | Int32 | Compatibility style flag that shows the leading/trailing days from adjacent months. | 0x0100 |
| CAL_ShowFocus | Int32 | Compatibility style flag that draws a focus rectangle around the selected day. | 0x0200 |
| CAL_ShowGrid | Int32 | Compatibility style flag that draws grid lines between the days of the calendar. | 0x0400 |
| CAL_ShowSpecial | Int32 | Compatibility style flag that highlights days marked as special. | 0x0800 |
| CALN_DateChanged | Int32 | Fired by VisCalendar and VisListViewDropDown as the wParam value with the SAM_CustControlCmd message when the user changes the selected date. | 1 |
| CALN_DateFinished | Int32 | Fired by VisCalendarDropDown as the wParam value with the SAM_CustControlCmd message when the user closes the drop down calendar. | 2 |
| CALN_Scroll | Int32 | Fired by VisCalendar and VisListViewDropDown as the wParam value with the SAM_CustControlCmd message when the user scrolls the calendar to a different month. | 3 |
| CAPTION_ErrorHandler | String | Default caption used for error handler message boxes. | "PPJ Framework" |
| COLOR_CAL_BackExtra | Int32 | Identifies the background color role for days outside the displayed month. | 2 |
| COLOR_CAL_BackLabel | Int32 | Color role for the background of the day-of-week label row. | 3 |
| COLOR_CAL_ForeDays | Int32 | Color role for the foreground of the regular day numbers. | 10 |
| COLOR_CAL_ForeExtra | Int32 | Color role for the foreground of the extra (adjacent month) day numbers. | 11 |
| COLOR_CAL_ForeMonth | Int32 | Color role for the foreground of the month/year caption. | 13 |
| COLOR_PAL_BackColor | Int32 | Identifies the palette background color role. | 0 |
| COLOR_PAL_BackMenu | Int32 | Color role for the palette's context menu background. | 2 |
| DAY_Friday | Int32 | Weekday selector for Friday, used by SPECIAL_Weekly and related rule types. | 6 |
| DAY_Monday | Int32 | Weekday selector for Monday, used by SPECIAL_Weekly and related rule types. | 2 |
| DAY_Saturday | Int32 | Weekday selector for Saturday, used by SPECIAL_Weekly and related rule types. | 7 |
| DAY_Sunday | Int32 | Weekday selector for Sunday, used by SPECIAL_Weekly and related rule types. | 1 |
| DAY_Thursday | Int32 | Weekday selector for Thursday, used by SPECIAL_Weekly and related rule types. | 5 |
| DAY_Tuesday | Int32 | Weekday selector for Tuesday, used by SPECIAL_Weekly and related rule types. | 3 |
| DAY_Unset | Int32 | Indicates that no weekday selector is set. | 0 |
| DAY_Wednesday | Int32 | Weekday selector for Wednesday, used by SPECIAL_Weekly and related rule types. | 4 |
| DBF_IncrementalTime | Int32 | Requests elapsed-time information in legacy debug output. | 0x10000 |
| DBF_MessageBox | Int32 | Debug flag that routes debug output through a message box. | 0x80000 |
| DBF_RealTime | Int32 | Debug flag that enables real-time debug output. | 0x20000 |
| DESKTOP_MyComputer | Int32 | Reserved item value representing the My Computer node in a desktop-style list. | -2 |
| DESKTOP_NetworkNeighborhood | Int32 | Reserved item value representing the Network Neighborhood node in a desktop-style list. | -3 |
| DESKTOP_Root | Int32 | Identifies the desktop root in the legacy desktop list. | -1 |
| DOS_BreakFlag | Int32 | DOS flag that controls Ctrl+Break checking. | 0x0002 |
| DOS_ErrorMode | Int32 | DOS flag that controls the critical-error handling mode. | 0x0004 |
| DOS_VerifyFlag | Int32 | Identifies the legacy DOS write-verification flag. | 0x0001 |
| DRIVE_CDROM | Int32 | Drive type flag for a CD-ROM drive. | 5 |
| DRIVE_Fixed | Int32 | Drive type flag for a fixed (hard) disk drive. | 3 |
| DRIVE_Floppy | Int32 | Identifies a removable disk drive. | 2 |
| DRIVE_Network | Int32 | Drive type flag for a network drive. | 4 |
| DRIVE_RAM | Int32 | Drive type flag for a RAM disk drive. | 6 |
| DROP_Child | Int32 | Marks a drop target as a child item. | 0x0001 |
| DROP_Sibling | Int32 | Drop flag indicating the drop target is a sibling of the dragged item rather than a child. | 0x0002 |
| DT_Handle | Int32 | Identifies a handle value in Visual Toolchest array operations. | 0x0100 |
| EM_SetReadOnly | Int32 | Identifies the edit-control message that changes read-only state. | 0x00cf |
| FA_Volume | Int32 | Identifies the legacy volume-label file attribute. | 0x0008 |
| FILETYPE_Document | Int32 | File type flag for a document file. | 2 |
| FILETYPE_Other | Int32 | File type flag for a file that does not match another known type. | 4 |
| FILETYPE_Program | Int32 | Identifies a program file. | 1 |
| FILETYPE_System | Int32 | File type flag for a system file. | 3 |
| FONTTYPE_Device | Int32 | Identifies a device font. | 0x0001 |
| FONTTYPE_Raster | Int32 | Font type flag for a raster (bitmap) font. | 0x0002 |
| FONTTYPE_TrueType | Int32 | Font type flag for a TrueType (scalable) font. | 0x0004 |
| hPicNull | Int32 | Represents a null Visual Toolchest picture handle. | 0 |
| ITEM_CanCollapse | UInt32 | List box item flag indicating the item can be collapsed. | 0x200000 |
| ITEM_CanDemote | UInt32 | List box item flag indicating the item can be demoted (indented) a level in the hierarchy. | 0x20000 |
| ITEM_CanExpand | UInt32 | List box item flag indicating the item can be expanded. | 0x100000 |
| ITEM_CanMoveDown | UInt32 | List box item flag indicating the item can move down among its siblings. | 0x80000 |
| ITEM_CanMoveUp | UInt32 | List box item flag indicating the item can move up among its siblings. | 0x40000 |
| ITEM_CanPromote | UInt32 | List box item flag indicating the item can be promoted (outdented) a level in the hierarchy. | 0x10000 |
| ITEM_IsDeleted | UInt32 | List box item flag indicating the item has been marked as deleted. | 0x20000000 |
| ITEM_IsDisabled | UInt32 | Marks a Visual Toolchest list item as disabled. | 0x1000000 |
| ITEM_IsExpanded | UInt32 | List box item flag indicating the item's children are expanded. | 0x80000000 |
| ITEM_IsFocus | UInt32 | List box item flag indicating the item has input focus. | 0x8000000 |
| ITEM_IsFrame | UInt32 | List box item flag indicating the item is drawn with a highlight frame. | 0x10000000 |
| ITEM_IsHidden | UInt32 | List box item flag indicating the item is hidden from view. | 0x2000000 |
| ITEM_IsParent | UInt32 | List box item flag indicating the item has child items. | 0x40000000 |
| ITEM_IsSelected | UInt32 | List box item flag indicating the item is selected. | 0x4000000 |
| KDS_Alt | Int32 | Key down state indicating the Alt key was down. | 4 |
| KDS_AltCtrl | Int32 | Key down state indicating the Alt and Ctrl keys were down. | 6 |
| KDS_AltShift | Int32 | Key down state indicating the Alt and Shift keys were down. | 5 |
| KDS_Ctrl | Int32 | Key down state indicating the Ctrl key was down. | 2 |
| KDS_None | Int32 | Indicates that no modifier key is pressed. | 0 |
| KDS_Shift | Int32 | Key down state indicating the Shift key was down. | 1 |
| KDS_ShiftAltCtrl | Int32 | Key down state indicating the Shift, Alt, and Ctrl keys were down. | 7 |
| KDS_ShiftCtrl | Int32 | Key down state indicating the Shift and Ctrl keys were down. | 3 |
| KS_Down | Int32 | Marks a key as currently pressed. | 0x8000 |
| KS_LockOn | Int32 | Key state flag bit indicating the key is toggled on (for example, Caps Lock). | 0x0001 |
| LBS_DisableNoScroll | Int32 | List box extended style that disables scrolling when the control is disabled. | 0x2000000 |
| LBS_DragSelect | Int32 | List box extended style that allows selecting a range of items by dragging. | 0x1000000 |
| LBS_Editable | Int32 | List box extended style that allows item text to be edited in place. | 0x80000 |
| LBS_Explorer | Int32 | List box extended style that uses Windows Explorer-style selection visuals. | 0x20000 |
| LBS_ExtendedCombo | Int32 | List box extended style that enables extended combo box behavior. | 0x8000001 |
| LBS_FmtLowercase | Int32 | List box extended style that displays item text in lowercase. | 0x0004 |
| LBS_FmtMixedcase | Int32 | List box extended style that displays item text using its original mixed case. | 0x40000 |
| LBS_FmtUppercase | Int32 | List box extended style that displays item text in uppercase. | 0x0002 |
| LBS_KillFocusFrameSelect | Int32 | List box extended style that draws the selection as a frame instead of a filled highlight when the control loses focus. | 0x0400 |
| LBS_KillFocusNoSelect | Int32 | List box extended style that does not keep the selection highlighted when the control loses focus. | 0x0200 |
| LBS_NoAutoResize | Int32 | List box extended style that prevents the control from automatically resizing its items. | 0x4000000 |
| LBS_SetWidthEachInsert | Int32 | List box extended style that recalculates the horizontal extent each time an item is inserted. | 0x1000 |
| LBS_ShowHorzScrollBar | Int32 | List box extended style that shows a horizontal scroll bar. | 0x10000 |
| LBS_ShowNoEditSelect | Int32 | List box extended style that does not select the item text when entering edit mode. | 0x0080 |
| LBS_ShowNoEditText | Int32 | List box extended style that prevents the item text from being edited. | 0x0100 |
| LBS_ShowNoSelect | Int32 | List box extended style that disables item selection. | 0x2000 |
| LBS_ShowNoTree | Int32 | List box extended style that hides the outline (tree) lines. | 0x0040 |
| LBS_ShowPicCenter | Int32 | List box extended style that centers the item picture vertically. | 0x0020 |
| LBS_ShowSelectBkgd | Int32 | List box extended style that shows the selection using the selection background color. | 0x8000 |
| LBS_ShowSelectColor | Int32 | List box extended style that shows the selection using the selection color. | 0x0008 |
| LBS_ShowSelectText | Int32 | List box extended style that shows the selection using the selection text color. | 0x0010 |
| LBS_ShowSelectTextPicture | Int32 | List box extended style that shows the selection around both the item's text and picture. | 0x4000 |
| LBS_VisExtensions | Int32 | Enables Visual Toolchest list-box extensions. | 0x0001 |
| LVA_AlignLeft | Int32 | Arrange code that aligns icons along the left edge of the control. | 0x0001 |
| LVA_AlignTop | Int32 | Arrange code that aligns icons along the top edge of the control. | 0x0002 |
| LVA_Default | Int32 | Selects the default list-view icon arrangement. | 0x0000 |
| LVA_SnapToGrid | Int32 | Arrange code that snaps icons to the nearest grid position. | 0x0005 |
| LVCF_Fmt | Int32 | Selects column-format information in a list-view column mask. | 0x0001 |
| LVCF_Text | Int32 | Column mask indicating the column's header text is valid. | 0x0004 |
| LVCF_Width | Int32 | Column mask indicating the column's width is valid. | 0x0002 |
| LVCFMT_Center | Int32 | Column alignment flag that center-aligns the column. | 0x0002 |
| LVCFMT_JustifyMask | Int32 | Mask that isolates the column alignment bits. | 0x0003 |
| LVCFMT_Left | Int32 | Aligns list-view column text to the left. | 0x0000 |
| LVCFMT_Right | Int32 | Column alignment flag that right-aligns the column. | 0x0001 |
| LVFI_NearestXY | Int32 | FindItem flag that searches for the item nearest to a given point. | 0x0040 |
| LVFI_Partial | Int32 | FindItem flag that matches items whose text begins with the search string. | 0x0008 |
| LVFI_String | Int32 | Searches list-view items by text. | 0x0002 |
| LVFI_Wrap | Int32 | FindItem flag that wraps the search to the beginning of the list when the end is reached. | 0x0020 |
| LVHT_Above | Int32 | HitTest flag indicating the point is above the client area. | 0x0008 |
| LVHT_Below | Int32 | HitTest flag indicating the point is below the client area. | 0x0010 |
| LVHT_Nowhere | Int32 | Indicates that a list-view hit test did not locate an item. | 0x0001 |
| LVHT_OnItem | Int32 | HitTest flag indicating the point is on the item (icon, label, or state icon). | 14 |
| LVHT_OnItemIcon | Int32 | HitTest flag indicating the point is on the item's icon. | 0x0002 |
| LVHT_OnItemLabel | Int32 | HitTest flag indicating the point is on the item's label. | 0x0004 |
| LVHT_OnItemStateIcon | Int32 | HitTest flag indicating the point is on the item's state icon. | 0x0008 |
| LVHT_ToLeft | Int32 | HitTest flag indicating the point is to the left of the client area. | 0x0040 |
| LVHT_ToRight | Int32 | HitTest flag indicating the point is to the right of the client area. | 0x0020 |
| LVIF_Image | Int32 | Item mask indicating the item's image index is valid. | 0x0002 |
| LVIF_Param | Int32 | Item mask indicating the item's application-defined value is valid. | 0x0004 |
| LVIF_State | Int32 | Item mask indicating the item's state is valid. | 0x0008 |
| LVIF_Text | Int32 | Selects the item-text field in a list-view item mask. | 0x0001 |
| LVIR_Bounds | Int32 | Selects the complete list-view item bounds. | 0 |
| LVIR_Icon | Int32 | ItemRect code for the bounding rectangle of the item's icon. | 1 |
| LVIR_Label | Int32 | ItemRect code for the bounding rectangle of the item's label text. | 2 |
| LVIR_SelectBounds | Int32 | ItemRect code for the bounding rectangle used to hit-test the item's selection. | 3 |
| LVIS_Cut | Int32 | Item state flag indicating the item is marked as cut for a move operation. | 0x0004 |
| LVIS_DropHilited | Int32 | Item state flag indicating the item is highlighted as a drop target. | 0x0008 |
| LVIS_Focused | Int32 | Marks a list-view item as focused. | 0x0001 |
| LVIS_Selected | Int32 | Item state flag indicating the item is selected. | 0x0002 |
| LVIS_StateImageMask | Int32 | Mask that isolates the state-image index bits of the item state. | 0xf000 |
| LVN_BeginDrag | Int32 | Notification message sent when a drag operation begins with the left mouse button. | -109 |
| LVN_BeginRDrag | Int32 | Notification message sent when a drag operation begins with the right mouse button. | -111 |
| LVN_ColumnClick | Int32 | Notification message sent when a column header is clicked. | -108 |
| LVN_DeleteAllItems | Int32 | Notification message sent before all items are deleted. | -104 |
| LVN_DeleteItem | Int32 | Notification message sent after an item has been deleted. | -103 |
| LVN_First | Int32 | Defines the base identifier for list-view notifications. | -100 |
| LVN_InsertItem | Int32 | Notification message sent after an item has been inserted. | -102 |
| LVN_ItemChanged | Int32 | Notification message sent after an item's attributes have changed. | -101 |
| LVN_ItemChanging | Int32 | Notification message sent before an item's attributes change. | -100 |
| LVNI_Above | Int32 | NextItem flag that searches for the item above the specified one. | 0x0100 |
| LVNI_All | Int32 | Selects all item states when searching for the next list-view item. | 0x0000 |
| LVNI_Below | Int32 | NextItem flag that searches for the item below the specified one. | 0x0200 |
| LVNI_Cut | Int32 | NextItem flag that restricts the search to items marked as cut. | 0x0004 |
| LVNI_DropHilited | Int32 | NextItem flag that restricts the search to items highlighted as a drop target. | 0x0008 |
| LVNI_Focused | Int32 | NextItem flag that restricts the search to the focused item. | 0x0001 |
| LVNI_Selected | Int32 | NextItem flag that restricts the search to selected items. | 0x0002 |
| LVNI_ToLeft | Int32 | NextItem flag that searches for the item to the left of the specified one. | 0x0400 |
| LVNI_ToRight | Int32 | NextItem flag that searches for the item to the right of the specified one. | 0x0800 |
| LVS_AlignLeft | Int32 | List view style that aligns icons to the left of the control. | 0x0800 |
| LVS_AlignMask | Int32 | Mask that isolates the icon alignment bits of the list view style. | 0x0c00 |
| LVS_AlignTop | Int32 | List view style that aligns icons to the top of the control. | 0x0000 |
| LVS_AutoArrange | Int32 | List view style that automatically arranges icons in icon/small-icon view. | 0x0100 |
| LVS_EditLabels | Int32 | List view style that allows item labels to be edited in place. | 0x0200 |
| LVS_Icon | Int32 | Selects the large-icon list-view mode. | 0x0000 |
| LVS_List | Int32 | List view style that displays items in a simple list view. | 0x0003 |
| LVS_NoColumnHeader | Int32 | List view style that hides the column header in report view. | 0x4000 |
| LVS_NoLabelWrap | Int32 | List view style that disables wrapping of item labels in icon view. | 0x0080 |
| LVS_NoScroll | Int32 | List view style that disables scrolling. | 0x2000 |
| LVS_NoSortHeader | Int32 | List view style that disables the button behavior of the column header. | 0x8000 |
| LVS_Report | Int32 | List view style that displays items in report (details) view. | 0x0001 |
| LVS_ShowSelAlways | Int32 | List view style that keeps the selection visible even when the control does not have focus. | 0x0008 |
| LVS_SingleSel | Int32 | List view style that allows only a single item to be selected at a time. | 0x0004 |
| LVS_SmallIcon | Int32 | List view style that displays items using small icons. | 0x0002 |
| LVS_TypeMask | Int32 | Mask that isolates the view-type bits (Icon/Report/SmallIcon/List) of the list view style. | 0x0003 |
| LVS_TypeStyleMask | Int32 | Mask that isolates the type-style bits of the list view style. | 0xfc00 |
| LVSORT_Ascending | Int32 | Selects ascending list-view sort order. | 0 |
| LVSORT_Descending | Int32 | Sorts list view items in descending order. | 1 |
| MBF_IconAsterisk | Int32 | Selects the information icon for a Visual Toolchest message box. | 0x10000 |
| MBF_IconError | Int32 | Message box flag that displays the error icon. | 0x20000 |
| MBF_IconExclamation | Int32 | Message box flag that displays the exclamation-point icon. | 0x80000 |
| MBF_IconHand | Int32 | Message box flag that displays the stop-sign (hand) icon. | 0x20000 |
| MBF_IconInformation | Int32 | Message box flag that displays the information icon. | 0x10000 |
| MBF_IconQuestion | Int32 | Message box flag that displays the question-mark icon. | 0x40000 |
| MBF_IconStop | Int32 | Message box flag that displays the stop icon. | 0x20000 |
| MBF_IconWarning | Int32 | Message box flag that displays the warning icon. | 0x80000 |
| MF_Check | Int32 | Menu flag that places a checkmark next to the menu item. | 0x0008 |
| MF_Disable | Int32 | Marks a menu item as disabled. | 0x0003 |
| MF_Separator | Int32 | Menu flag that creates a horizontal separator line instead of a menu item. | 0x0800 |
| NM_Click | Int32 | Notification code sent when the control is clicked. | -2 |
| NM_DoubleClick | Int32 | Notification code sent when the control is double-clicked. | -3 |
| NM_First | Int32 | Defines the base value for generic control notifications. | -1 |
| NM_KillFocus | Int32 | Notification code sent when the control loses input focus. | -8 |
| NM_OutOfMemory | Int32 | Notification code indicating the control ran out of memory while processing a request. | -1 |
| NM_Return | Int32 | Notification code sent when Enter is pressed while the control has focus. | -4 |
| NM_RightClick | Int32 | Notification code sent when the control is right-clicked. | -5 |
| NM_RightDoubleClick | Int32 | Notification code sent when the control is right-double-clicked. | -6 |
| NM_SetFocus | Int32 | Notification code sent when the control receives input focus. | -7 |
| ORIENT_SPLIT_Horizontal | Int32 | Orientation value indicating the splitter is oriented horizontally. | 0 |
| ORIENT_SPLIT_Unset | Int32 | Indicates that a splitter orientation is not set. | -1 |
| ORIENT_SPLIT_Vertical | Int32 | Orientation value indicating the splitter is oriented vertically. | 1 |
| PAL_EnableMRUColors | Int32 | Enables the recent-colors area in a color palette. | 0x0004 |
| PAL_NoHideSelects | Int32 | Compatibility style flag that keeps the selection highlighted when the palette loses focus. | 0x0008 |
| PALETTE_Main | Int32 | Palette code for the main color palette. | 0 |
| PALETTE_MRU | Int32 | Palette code for the most-recently-used color palette. | 1 |
| PALN_Changed | Int32 | Notification message sent when the palette selection has changed. | 1 |
| PALN_ErrSpace | Int32 | Identifies an allocation-error notification from a color palette. | -1 |
| PALN_Finished | Int32 | Notification message sent when the user has finished interacting with the palette. | 2 |
| PALN_Menu | Int32 | Notification message sent when a palette context menu command is selected. | 3 |
| PIC_LoadFile | Int32 | Picture flag indicating the picture should be loaded from a file. | 0x0400 |
| PIC_LoadLargeIcon | Int32 | Picture flag indicating a large icon should be loaded. | 0x2000 |
| PIC_LoadResource | Int32 | Picture flag indicating the picture should be loaded from an embedded module resource. | 0x0200 |
| PIC_LoadSmallIcon | Int32 | Picture flag indicating a small icon should be loaded. | 0x1000 |
| PIC_LoadSWinRes | Int32 | Picture flag indicating the picture should be loaded from a SQLWindows resource. | 0x0800 |
| PIC_LoadSWinStr | Int32 | Loads picture data from a SAL string blob. | 0x0100 |
| PicDesktop | SalNumber | Stores the cached picture handle for the desktop image. | |
| PicDriveCD | SalNumber | Stores the cached picture handle for the CD-ROM drive image. | |
| PicDriveFixed | SalNumber | Stores the cached picture handle for the fixed drive image. | |
| PicDriveFloppy | SalNumber | Stores the cached picture handle for the floppy drive image. | |
| PicDriveNetwork | SalNumber | Stores the cached picture handle for the network drive image. | |
| PicDriveRemovable | SalNumber | Stores the cached picture handle for the removable drive image. | |
| PicFolderClosed | SalNumber | Stores the cached picture handle for the closed folder image. | |
| PicFolderOpen | SalNumber | Stores the cached picture handle for the open folder image. | |
| PicMyComputer | SalNumber | Stores the cached picture handle for the My Computer image. | |
| PicNetworkNeighborhood | SalNumber | Stores the cached picture handle for the Network Neighborhood image. | |
| PicTTFont | SalNumber | Stores the cached picture handle for the TrueType font image. | |
| REF_AutoHScroll | Int32 | Compatibility option that enables automatic horizontal scrolling. | 0x0080 |
| REF_AutoVScroll | Int32 | Compatibility option that enables automatic vertical scrolling. | 0x0040 |
| REF_AutoWordSelection | Int32 | Option Flags (duplicates of ECO_ constants from Microsoft's RICHEDIT.H). | 0x0001 |
| REF_CFE_AutoColor | Int32 | Character Format Flags (duplicates of CFE_ constants from Microsoft's RICHEDIT.H). | 0x40000000 |
| REF_CFE_Bold | Int32 | Character format flag for bold text. | 0x0001 |
| REF_CFE_Italic | Int32 | Character format flag for italic text. | 0x0002 |
| REF_CFE_Protected | Int32 | Character format flag that marks the text as protected from editing. | 0x0010 |
| REF_CFE_Strikeout | Int32 | Character format flag for strikeout text. | 0x0008 |
| REF_CFE_Underline | Int32 | Character format flag for underlined text. | 0x0004 |
| REF_FT_MatchCase | Int32 | Makes a rich-edit text search case-sensitive. | 0x0004 |
| REF_FT_WholeWord | Int32 | Find text flag that matches whole words only. | 0x0002 |
| REF_NoHideSel | Int32 | Compatibility option that keeps the selection highlighted when the control loses focus. | 0x0100 |
| REF_PFA_Center | Int32 | Paragraph format flag that center-aligns the paragraph. | 0x0003 |
| REF_PFA_Left | Int32 | Paragraph Format Alignment Flags (duplicates of PFA_ constants from Microsoft's RICHEDIT.H). | 0x0001 |
| REF_PFA_Right | Int32 | Paragraph format flag that right-aligns the paragraph. | 0x0002 |
| REF_PFN_Bullet | Int32 | Paragraph Format Numbering Flags (duplicates of PFN_ constants from Microsoft's RICHEDIT.H). | 0x0001 |
| REF_ReadOnly | Int32 | Compatibility option that makes the control read-only. | 0x0800 |
| REF_SaveSelection | Int32 | Compatibility option that preserves the selection when the control loses focus. | 0x8000 |
| REF_SEL_Empty | Int32 | Selection Flags (duplicates of SEL_ constants from Microsoft's RICHEDIT.H). | 0x0000 |
| REF_SEL_MultiChar | Int32 | Selection flag indicating the selection spans more than one character. | 0x0004 |
| REF_SEL_MultiObject | Int32 | Selection flag indicating the selection spans more than one object. | 0x0008 |
| REF_SEL_Object | Int32 | Selection flag indicating the selection contains an OLE object. | 0x0002 |
| REF_SEL_Text | Int32 | Selection flag indicating the selection contains text. | 0x0001 |
| REF_Vertical | Int32 | Compatibility option that displays text vertically. | 0x400000 |
| REGION_Main | Int32 | Identifies the main palette region. | 0 |
| REGION_Menu | Int32 | Region code for the palette's context-menu region. | 1 |
| REGION_MRU | Int32 | Region code for the palette's most-recently-used color region. | 2 |
| REN_Change | Int32 | Message type sent when the contents change. | 4 |
| REN_ErrSpace | Int32 | Identifies a rich-edit allocation-error notification. | 0 |
| REN_HScroll | Int32 | Message type sent when the control is scrolled horizontally. | 5 |
| REN_MaxText | Int32 | Message type sent when the text has reached its maximum length. | 8 |
| REN_Protected | Int32 | Message type sent when the user attempts to modify protected text. | 1 |
| REN_RequestResize | Int32 | Message type sent when the control requests to be resized. | 2 |
| REN_SelChange | Int32 | Message type sent when the selection changes. | 3 |
| REN_Update | Int32 | Message type sent when the control's display needs to be updated. | 7 |
| REN_VScroll | Int32 | Message type sent when the control is scrolled vertically. | 6 |
| ROW_UserFlag1 | Int32 | Reserves the first application-defined table-row flag. | 0x0080 |
| ROW_UserFlag2 | Int32 | Application-defined (user) flag bit 2 for a row. | 0x0100 |
| ROW_UserFlag3 | Int32 | Application-defined (user) flag bit 3 for a row. | 0x0200 |
| ROW_UserFlag4 | Int32 | Application-defined (user) flag bit 4 for a row. | 0x0400 |
| ROW_UserFlag5 | Int32 | Application-defined (user) flag bit 5 for a row. | 0x0800 |
| SEEK_Begin | Int32 | Measures a seek offset from the beginning of a file. | 0 |
| SEEK_Current | Int32 | Seek origin indicating a position relative to the current file position. | 1 |
| SEEK_End | Int32 | Seek origin indicating a position relative to the end of the file. | 2 |
| SEQ_First | Int32 | Sequence selector for the first occurrence of a weekday within a month. | 1 |
| SEQ_Fourth | Int32 | Sequence selector for the fourth occurrence of a weekday within a month. | 4 |
| SEQ_Last | Int32 | Sequence selector for the last occurrence of a weekday within a month. | 5 |
| SEQ_Second | Int32 | Sequence selector for the second occurrence of a weekday within a month. | 2 |
| SEQ_Third | Int32 | Sequence selector for the third occurrence of a weekday within a month. | 3 |
| SEQ_Unset | Int32 | Indicates that no weekday sequence is selected. | 0 |
| SHOW_AllLevels | Int32 | Show All Levels. | 32767 |
| SHOW_Hidden | Int32 | Requests that a window remain hidden. | 0 |
| SHOW_Maximized | Int32 | Show window flag that shows the window maximized. | 3 |
| SHOW_Minimized | Int32 | Show window flag that shows the window minimized. | 2 |
| SHOW_Normal | Int32 | Show window flag that shows the window in its normal state. | 1 |
| SM_DBCSEnabled | Int32 | System metrics index that is non-zero if the double-byte character set version of Windows is installed. | 42 |
| SM_Debug | Int32 | System metrics index that is non-zero if the debug version of Windows is installed. | 22 |
| SM_MenuDropAlignment | Int32 | System metrics index that is non-zero if popup menus are right-aligned relative to their owner. | 40 |
| SM_MousePresent | Int32 | System metrics index that is non-zero if a mouse is installed. | 19 |
| SM_PenWindows | Int32 | System metrics index that is non-zero if Windows for Pen Computing is installed. | 41 |
| SM_SwapButton | Int32 | System metrics index that is non-zero if the mouse buttons are swapped. | 23 |
| SM_XBorder | Int32 | System metrics index for the width of a window border. | 5 |
| SM_XCursor | Int32 | System metrics index for the width of a cursor. | 13 |
| SM_XDlgFrame | Int32 | System metrics index for the width of a dialog frame. | 7 |
| SM_XDoubleClick | Int32 | System metrics index for the width of the rectangle used to detect a double-click. | 36 |
| SM_XFrame | Int32 | System metrics index for the width of a resizable window frame. | 32 |
| SM_XFullScreen | Int32 | System metrics index for the width of the client area of a full-screen window. | 16 |
| SM_XHScroll | Int32 | System metrics index for the width of the arrow bitmap on a horizontal scroll bar. | 21 |
| SM_XHThumb | Int32 | System metrics index for the width of the thumb box on a horizontal scroll bar. | 10 |
| SM_XIcon | Int32 | System metrics index for the width of a default icon. | 11 |
| SM_XIconSpacing | Int32 | System metrics index for the horizontal spacing between icons in large icon view. | 38 |
| SM_XMin | Int32 | System metrics index for the minimum width of a window. | 28 |
| SM_XMinTrack | Int32 | System metrics index for the minimum tracking width of a window. | 34 |
| SM_XScreen | Int32 | Identifies the screen-width system metric. | 0 |
| SM_XSize | Int32 | System metrics index for the width of a caption button bitmap. | 30 |
| SM_XVScroll | Int32 | System metrics index for the width of the arrow bitmap on a vertical scroll bar. | 2 |
| SM_YBorder | Int32 | System metrics index for the height of a window border. | 6 |
| SM_YCaption | Int32 | System metrics index for the height of a window caption. | 4 |
| SM_YCursor | Int32 | System metrics index for the height of a cursor. | 14 |
| SM_YDlgFrame | Int32 | System metrics index for the height of a dialog frame. | 8 |
| SM_YDoubleClick | Int32 | System metrics index for the height of the rectangle used to detect a double-click. | 37 |
| SM_YFrame | Int32 | System metrics index for the height of a resizable window frame. | 33 |
| SM_YFullScreen | Int32 | System metrics index for the height of the client area of a full-screen window. | 17 |
| SM_YHScroll | Int32 | System metrics index for the height of the arrow bitmap on a horizontal scroll bar. | 3 |
| SM_YIcon | Int32 | System metrics index for the height of a default icon. | 12 |
| SM_YIconSpacing | Int32 | System metrics index for the vertical spacing between icons in large icon view. | 39 |
| SM_YKanjiWindow | Int32 | System metrics index for the height of the Kanji input window. | 18 |
| SM_YMenu | Int32 | System metrics index for the height of a single-line menu bar. | 15 |
| SM_YMin | Int32 | System metrics index for the minimum height of a window. | 29 |
| SM_YMinTrack | Int32 | System metrics index for the minimum tracking height of a window. | 35 |
| SM_YScreen | Int32 | System metrics index for the height of the screen. | 1 |
| SM_YSize | Int32 | System metrics index for the height of a caption button bitmap. | 31 |
| SM_YVScroll | Int32 | System metrics index for the height of the arrow bitmap on a vertical scroll bar. | 20 |
| SM_YVThumb | Int32 | System metrics index for the height of the thumb box on a vertical scroll bar. | 9 |
| SORT_Ascending | Int32 | Sort ascending flag for ArraySort. | 0 |
| SORT_Descending | Int32 | Sort descending flag for ArraySort. | 1 |
| SPECIAL_MonthlyDOM | Int32 | Special rule type indicating a date that recurs monthly on a fixed day of the month. | 3 |
| SPECIAL_MonthlyDOW | Int32 | Special rule type indicating a date that recurs monthly on a specific day-of-week sequence. | 4 |
| SPECIAL_OneTime | Int32 | Special rule type indicating a date that occurs only once. | 1 |
| SPECIAL_Unset | Int32 | Indicates that no special-date recurrence rule is selected. | 0 |
| SPECIAL_Weekly | Int32 | Special rule type indicating a date that recurs every week on a given day. | 2 |
| SPECIAL_Yearly | Int32 | Special rule type indicating a date that recurs yearly on a fixed date. | 5 |
| SPECIAL_YearlyDOW | Int32 | Special rule type indicating a date that recurs yearly on a specific day-of-week sequence. | 6 |
| VK_0 | Int32 | Identifies the 0 virtual key. | 0x0030 |
| VK_1 | Int32 | Identifies the 1 virtual key. | 0x0031 |
| VK_2 | Int32 | Identifies the 2 virtual key. | 0x0032 |
| VK_3 | Int32 | Identifies the 3 virtual key. | 0x0033 |
| VK_4 | Int32 | Identifies the 4 virtual key. | 0x0034 |
| VK_5 | Int32 | Identifies the 5 virtual key. | 0x0035 |
| VK_6 | Int32 | Identifies the 6 virtual key. | 0x0036 |
| VK_7 | Int32 | Identifies the 7 virtual key. | 0x0037 |
| VK_8 | Int32 | Identifies the 8 virtual key. | 0x0038 |
| VK_9 | Int32 | Identifies the 9 virtual key. | 0x0039 |
| VK_A | Int32 | Identifies the A virtual key. | 0x0041 |
| VK_Add | Int32 | Identifies the Add virtual key. | 0x006b |
| VK_Alt | Int32 | Identifies the Alt virtual key. | 0x0012 |
| VK_B | Int32 | Identifies the B virtual key. | 0x0042 |
| VK_Backspace | Int32 | Identifies the Backspace virtual key. | 0x0008 |
| VK_C | Int32 | Identifies the C virtual key. | 0x0043 |
| VK_Cancel | Int32 | Identifies the Cancel virtual key. | 0x0003 |
| VK_CapsLock | Int32 | Identifies the Caps Lock virtual key. | 0x0014 |
| VK_Clear | Int32 | Identifies the Clear virtual key. | 0x000c |
| VK_Control | Int32 | Identifies the Control virtual key. | 0x0011 |
| VK_D | Int32 | Identifies the D virtual key. | 0x0044 |
| VK_Decimal | Int32 | Identifies the Decimal virtual key. | 0x006e |
| VK_Delete | Int32 | Identifies the Delete virtual key. | 0x002e |
| VK_Divide | Int32 | Identifies the Divide virtual key. | 0x006f |
| VK_Down | Int32 | Identifies the Down virtual key. | 0x0028 |
| VK_E | Int32 | Identifies the E virtual key. | 0x0045 |
| VK_End | Int32 | Identifies the End virtual key. | 0x0023 |
| VK_Enter | Int32 | Identifies the Enter virtual key. | 0x000d |
| VK_Escape | Int32 | Identifies the Escape virtual key. | 0x001b |
| VK_Execute | Int32 | Identifies the Execute virtual key. | 0x002b |
| VK_F | Int32 | Identifies the F virtual key. | 0x0046 |
| VK_F1 | Int32 | Identifies the F1 virtual key. | 0x0070 |
| VK_F10 | Int32 | Identifies the F10 virtual key. | 0x0079 |
| VK_F11 | Int32 | Identifies the F11 virtual key. | 0x007a |
| VK_F12 | Int32 | Identifies the F12 virtual key. | 0x007b |
| VK_F2 | Int32 | Identifies the F2 virtual key. | 0x0071 |
| VK_F3 | Int32 | Identifies the F3 virtual key. | 0x0072 |
| VK_F4 | Int32 | Identifies the F4 virtual key. | 0x0073 |
| VK_F5 | Int32 | Identifies the F5 virtual key. | 0x0074 |
| VK_F6 | Int32 | Identifies the F6 virtual key. | 0x0075 |
| VK_F7 | Int32 | Identifies the F7 virtual key. | 0x0076 |
| VK_F8 | Int32 | Identifies the F8 virtual key. | 0x0077 |
| VK_F9 | Int32 | Identifies the F9 virtual key. | 0x0078 |
| VK_G | Int32 | Identifies the G virtual key. | 0x0047 |
| VK_H | Int32 | Identifies the H virtual key. | 0x0048 |
| VK_Help | Int32 | Identifies the Help virtual key. | 0x002f |
| VK_Home | Int32 | Identifies the Home virtual key. | 0x0024 |
| VK_I | Int32 | Identifies the I virtual key. | 0x0049 |
| VK_Insert | Int32 | Identifies the Insert virtual key. | 0x002d |
| VK_J | Int32 | Identifies the J virtual key. | 0x004a |
| VK_K | Int32 | Identifies the K virtual key. | 0x004b |
| VK_L | Int32 | Identifies the L virtual key. | 0x004c |
| VK_Left | Int32 | Identifies the Left virtual key. | 0x0025 |
| VK_LeftButton | Int32 | Identifies the Left Button virtual key. | 0x0001 |
| VK_M | Int32 | Identifies the M virtual key. | 0x004d |
| VK_MiddleButton | Int32 | Identifies the Middle Button virtual key. | 0x0004 |
| VK_Multiply | Int32 | Identifies the Multiply virtual key. | 0x006a |
| VK_N | Int32 | Identifies the N virtual key. | 0x004e |
| VK_NumLock | Int32 | Identifies the Num Lock virtual key. | 0x0090 |
| VK_O | Int32 | Identifies the O virtual key. | 0x004f |
| VK_P | Int32 | Identifies the P virtual key. | 0x0050 |
| VK_PageDown | Int32 | Identifies the Page Down virtual key. | 0x0022 |
| VK_PageUp | Int32 | Identifies the Page Up virtual key. | 0x0021 |
| VK_Pause | Int32 | Identifies the Pause virtual key. | 0x0013 |
| VK_PrintScreen | Int32 | Identifies the Print Screen virtual key. | 0x002c |
| VK_Q | Int32 | Identifies the Q virtual key. | 0x0051 |
| VK_R | Int32 | Identifies the R virtual key. | 0x0052 |
| VK_Right | Int32 | Identifies the Right virtual key. | 0x0027 |
| VK_RightButton | Int32 | Identifies the Right Button virtual key. | 0x0002 |
| VK_S | Int32 | Identifies the S virtual key. | 0x0053 |
| VK_ScrollLock | Int32 | Identifies the Scroll Lock virtual key. | 0x0091 |
| VK_Select | Int32 | Identifies the Select virtual key. | 0x0029 |
| VK_Separator | Int32 | Identifies the Separator virtual key. | 0x006c |
| VK_Shift | Int32 | Identifies the Shift virtual key. | 0x0010 |
| VK_Space | Int32 | Identifies the Space virtual key. | 0x0020 |
| VK_Subtract | Int32 | Identifies the Subtract virtual key. | 0x006d |
| VK_T | Int32 | Identifies the T virtual key. | 0x0054 |
| VK_Tab | Int32 | Identifies the Tab virtual key. | 0x0009 |
| VK_U | Int32 | Identifies the U virtual key. | 0x0055 |
| VK_Up | Int32 | Identifies the Up virtual key. | 0x0026 |
| VK_V | Int32 | Identifies the V virtual key. | 0x0056 |
| VK_W | Int32 | Identifies the W virtual key. | 0x0057 |
| VK_X | Int32 | Identifies the X virtual key. | 0x0058 |
| VK_Y | Int32 | Identifies the Y virtual key. | 0x0059 |
| VK_Z | Int32 | Identifies the Z virtual key. | 0x005a |
| VT_DLLName | String | Identifies the built-in Visual Toolchest image resource collection. | "PPJ.Runtime.Vis.Resources" |
| VT_EmbeddedResource | String | Name of the embedded resource file that stores the Visual Toolchest's built-in pictures. | "resource.wx" |
| VT_SWP_NoZOrder | Int32 | Preserves a window's stacking order when positioning it. | 0x0004 |
| VTERR_AccessDenied | Int32 | Error return value that maps to the Windows ERROR_ACCESS_DENIED code. | -5 |
| VTERR_BadNetName | Int32 | Error return value that maps to the Windows ERROR_BAD_NET_NAME code. | -67 |
| VTERR_BadNetPath | Int32 | Error return value that maps to the Windows ERROR_BAD_NETPATH code. | -53 |
| VTERR_DiskFull | Int32 | Error return value that maps to the Windows ERROR_HANDLE_DISK_FULL code. | -39 |
| VTERR_DriveNotReady | Int32 | Error return value that maps to the Windows ERROR_NOT_READY code. | -21 |
| VTERR_EndOfFile | Int32 | Error return value indicating the end of the file has been reached. | -18 |
| VTERR_FileNotFound | Int32 | Error return value that maps to the Windows ERROR_FILE_NOT_FOUND code. | -2 |
| VTERR_InvalidData | Int32 | Error return value that maps to the Windows ERROR_INVALID_DATA code. | -13 |
| VTERR_InvalidDrive | Int32 | Error return value that maps to the Windows ERROR_INVALID_DRIVE code. | -15 |
| VTERR_InvalidHandle | Int32 | Error return value that maps to the Windows ERROR_INVALID_HANDLE code. | -6 |
| VTERR_InvalidParameter | Int32 | Error return value that maps to the Windows ERROR_INVALID_PARAMETER code. | -87 |
| VTERR_LockViolation | Int32 | Error return value that maps to the Windows ERROR_LOCK_VIOLATION code. | -33 |
| VTERR_NetNameDeleted | Int32 | Error return value that maps to the Windows ERROR_NETNAME_DELETED code. | -64 |
| VTERR_NetworkAccessDenied | Int32 | Error return value that maps to the Windows ERROR_NETWORK_ACCESS_DENIED code. | -65 |
| VTERR_NetworkBusy | Int32 | Error return value that maps to the Windows ERROR_NETWORK_BUSY code. | -54 |
| VTERR_NetworkUnreachable | Int32 | Error return value that maps to the Windows ERROR_NETWORK_UNREACHABLE code. | -1231 |
| VTERR_NetWriteFault | Int32 | Error return value that maps to the Windows ERROR_NET_WRITE_FAULT code. | -88 |
| VTERR_NoMemory | Int32 | Error return value that maps to the Windows ERROR_NOT_ENOUGH_MEMORY code. | -8 |
| VTERR_NoMoreFiles | Int32 | Error return value that maps to the Windows ERROR_NO_MORE_FILES code. | -18 |
| VTERR_Ok | Int32 | Error return values - these are remaps of values found in SDK's WINERROR.H. | 0 |
| VTERR_PathNotFound | Int32 | Error return value that maps to the Windows ERROR_PATH_NOT_FOUND code. | -3 |
| VTERR_ReadFault | Int32 | Error return value that maps to the Windows ERROR_READ_FAULT code. | -30 |
| VTERR_SharingViolation | Int32 | Error return value that maps to the Windows ERROR_SHARING_VIOLATION code. | -32 |
| VTERR_TooManyFiles | Int32 | Error return value that maps to the Windows ERROR_TOO_MANY_OPEN_FILES code. | -4 |
| VTERR_WriteFault | Int32 | Error return value that maps to the Windows ERROR_WRITE_FAULT code. | -29 |
| VTERR_WriteProtected | Int32 | Error return value that maps to the Windows ERROR_WRITE_PROTECT code. | -19 |
| VTM_Accelerator | Int32 | Notification identifier sent when an accelerator key associated with the control is processed. | 24582 |
| VTM_Base | Int32 | Defines the base identifier for Visual Toolchest messages. | 0x6000 |
| VTM_Char | Int32 | Identifies the native window message WM_CHAR. | 0x0102 |
| VTM_Click | Int32 | Notification identifier sent when the control is clicked. | 24579 |
| VTM_ControlCreate | Int32 | Notification identifier sent when a control is created. | 24584 |
| VTM_Create | Int32 | Identifies the native nonclient-create message used by Visual Toolchest controls. | 0x0081 |
| VTM_CreateComplete | Int32 | Notification identifier sent when creation of the control hierarchy has completed. | 24586 |
| VTM_Destroy | Int32 | Notification identifier sent when the control is being destroyed. | 24580 |
| VTM_Enable | Int32 | Identifies the native window message WM_ENABLE. | 0x000a |
| VTM_EraseBkgnd | Int32 | Identifies the native window message WM_ERASEBKGND. | 0x0014 |
| VTM_KeyDown | Int32 | Identifies the native window message WM_KEYDOWN. | 0x0100 |
| VTM_KeyUp | Int32 | Identifies the native window message WM_KEYUP. | 0x0101 |
| VTM_LeftClick | Int32 | Identifies the native window message WM_LBUTTONUP. | 0x0202 |
| VTM_LeftDoubleClick | Int32 | Identifies the native window message WM_LBUTTONDBLCLK. | 0x0203 |
| VTM_LVColumnClick | Int32 | Identifies a list-view column-header click notification. | 24590 |
| VTM_MenuSelect | Int32 | Notification identifier sent when a menu item created using Vis functions is selected. | 24583 |
| VTM_MiddleClick | Int32 | Identifies the native window message WM_MBUTTONUP. | 0x0208 |
| VTM_MiddleDoubleClick | Int32 | Identifies the native window message WM_MBUTTONDBLCLK. | 0x0209 |
| VTM_OutlineCornerClick | Int32 | Notification identifier sent when the expand/collapse glyph of an outline item is clicked. | 24585 |
| VTM_Populate | Int32 | Notification identifier sent when the control's contents need to be populated. | 24581 |
| VTM_RightClick | Int32 | Identifies the native window message WM_RBUTTONUP. | 0x0205 |
| VTM_RightDoubleClick | Int32 | Identifies the native window message WM_RBUTTONDBLCLK. | 0x0206 |
| VTM_Size | Int32 | Identifies the native window message WM_SIZE. | 0x0005 |
| VTM_SpinGetValue | Int32 | Notification identifier that retrieves the spin control's current value. | 1031 |
| VTM_SpinScrollDown | Int32 | Notification identifier sent when the spin control is scrolled down (decremented). | 1030 |
| VTM_SpinScrollUp | Int32 | Notification identifier sent when the spin control is scrolled up (incremented). | 1029 |
| VTM_SpinSetIncrement | Int32 | Notification identifier that sets the spin control's increment amount. | 1027 |
| VTM_SpinSetMax | Int32 | Notification identifier that sets the spin control's maximum value. | 1026 |
| VTM_SpinSetMin | Int32 | Identifies the spin-field message that sets the minimum value. | 1025 |
| VTM_SpinSetValue | Int32 | Notification identifier that sets the spin control's current value. | 1028 |
| VTPIC_BookClosed | String | Names the built-in book closed picture resource. | "bkclosed" |
| VTPIC_BookOpen | String | Names the built-in book open picture resource. | "bkopen" |
| VTPIC_BookShelf2 | String | Names the built-in book shelf2 picture resource. | "bkshelf2" |
| VTPIC_BookShelf3 | String | Names the built-in book shelf3 picture resource. | "bkshelf3" |
| VTPIC_CheckBlack | String | Names the built-in check black picture resource. | "chkblk" |
| VTPIC_CheckBoxOff | String | Names the built-in check box off picture resource. | "ckbxoff2" |
| VTPIC_CheckBoxOn | String | Names the built-in check box on picture resource. | "ckbxon2" |
| VTPIC_CheckWhite | String | Names the built-in check white picture resource. | "chkwht" |
| VTPIC_Desktop | String | Names the built-in desktop picture resource. | "desktop" |
| VTPIC_DiamondBlackClosed | String | Names the built-in diamond black closed picture resource. | "diablkc" |
| VTPIC_DiamondBlackOpen | String | Names the built-in diamond black open picture resource. | "diablko" |
| VTPIC_DiamondWhiteClosed | String | Names the built-in diamond white closed picture resource. | "diawhtc" |
| VTPIC_DiamondWhiteOpen | String | Names the built-in diamond white open picture resource. | "diawhto" |
| VTPIC_DriveCDROM | String | Names the built-in drive cdrom picture resource. | "drvcd2" |
| VTPIC_DriveCDROM2 | String | Names the built-in drive cdrom2 picture resource. | "drvcd3" |
| VTPIC_DriveFixed | String | Names the built-in drive fixed picture resource. | "drvhard2" |
| VTPIC_DriveFloppy | String | Names the built-in drive floppy picture resource. | "drvflop2" |
| VTPIC_DriveNetwork | String | Names the built-in drive network picture resource. | "drvnet2" |
| VTPIC_DriveNetworkX | String | Names the built-in drive network x picture resource. | "drvnetx" |
| VTPIC_DriveRAM | String | Names the built-in drive ram picture resource. | "drvram2" |
| VTPIC_Empty | String | Names the built-in empty picture resource. | "empty" |
| VTPIC_FileAllOther | String | Names the built-in file all other picture resource. | "fileall" |
| VTPIC_FileDocuments | String | Names the built-in file documents picture resource. | "filedoc" |
| VTPIC_FilePrograms | String | Names the built-in file programs picture resource. | "fileprog" |
| VTPIC_FileSystem | String | Names the built-in file system picture resource. | "filesys" |
| VTPIC_Folder | String | Names the built-in folder picture resource. | "fdr" |
| VTPIC_Folder2 | String | Names the built-in folder2 picture resource. | "fdr" |
| VTPIC_FolderCur | String | Names the built-in folder cur picture resource. | "fdrcur" |
| VTPIC_FolderCurMinus | String | Names the built-in folder cur minus picture resource. | "fdrcurm" |
| VTPIC_FolderCurPlus | String | Names the built-in folder cur plus picture resource. | "fdrcurp" |
| VTPIC_FolderMinus | String | Names the built-in folder minus picture resource. | "fdrmnus" |
| VTPIC_FolderOpen | String | Names the built-in folder open picture resource. | "fdropen" |
| VTPIC_FolderOpen2 | String | Names the built-in folder open2 picture resource. | "fdropen" |
| VTPIC_FolderPlus | String | Names the built-in folder plus picture resource. | "fdrplus" |
| VTPIC_FontPrinter | String | Names the built-in font printer picture resource. | "fonprtr" |
| VTPIC_FontTrueType | String | Names the built-in font true type picture resource. | "fontrtyp" |
| VTPIC_MinusDark | String | Names the built-in minus dark picture resource. | "minusdk" |
| VTPIC_MinusLight | String | Names the built-in minus light picture resource. | "minuslt" |
| VTPIC_MinusWhite | String | Names the built-in minus white picture resource. | "minuswht" |
| VTPIC_MyComputer | String | Names the built-in my computer picture resource. | "mycomp" |
| VTPIC_NetworkNeighborhood | String | Names the built-in network neighborhood picture resource. | "netneigh" |
| VTPIC_PlusDark | String | Names the built-in plus dark picture resource. | "plusdk" |
| VTPIC_PlusLight | String | Names the built-in plus light picture resource. | "pluslt" |
| VTPIC_PlusWhite | String | Names the built-in plus white picture resource. | "pluswht" |
| VTPIC_PrevDirectory | String | Names the built-in prev directory picture resource. | "prevdir" |
| VTPIC_RadioOff | String | Names the built-in radio off picture resource. | "radoff2" |
| VTPIC_RadioOn | String | Names the built-in radio on picture resource. | "radon2" |
| WAIT_SysModalOff | Int32 | Wait cursor flag that removes a system-modal wait cursor. | 5 |
| WAIT_SysModalOn | Int32 | Wait cursor flag that displays a system-modal wait cursor. | 4 |
| WAIT_TempOff | Int32 | Wait cursor flag that restores the previous cursor after a temporary wait cursor. | 3 |
| WAIT_TempOn | Int32 | Requests a temporary wait cursor. | 2 |
| WF_80x87 | Int32 | Windows flag indicating a math coprocessor is installed. | 0x0400 |
| WF_CPU286 | Int32 | Windows flag indicating the system's processor is an 80286. | 0x0002 |
| WF_CPU386 | Int32 | Windows flag indicating the system's processor is an 80386. | 0x0004 |
| WF_CPU486 | Int32 | Windows flag indicating the system's processor is an 80486 or later. | 0x0008 |
| WF_DisplayOnly | Int32 | Window flag that makes the field display-only (not editable). | 0x0010 |
| WF_EnableWhenNotNull | Int32 | Window flag that enables the field only when its value is not null. | 0x10000 |
| WF_Enhanced | Int32 | Windows flag indicating Windows is running in 386 enhanced mode. | 0x0020 |
| WF_FitPath | Int32 | Window flag that fits (truncates) a path to fit the field's width. | 0x0008 |
| WF_NoClear | Int32 | Window flag that prevents the field's content from being cleared. | 0x0002 |
| WF_NoClearEditFlag | Int32 | Window flag that prevents the field's edited flag from being cleared. | 0x0004 |
| WF_Paging | Int32 | Windows flag indicating the system supports paging. | 0x0800 |
| WF_PMode | Int32 | Identifies the legacy protected-mode Windows flag. | 0x0001 |
| WF_Required | Int32 | Marks a field as requiring a value. | 0x0001 |
| WF_Standard | Int32 | Windows flag indicating Windows is running in standard mode. | 0x0010 |
| WF_WLO | Int32 | Windows flag indicating Windows is running in Win32s on Windows 3.1. | 0x8000 |
Methods
ArrayAppend(hArySource, hAryTarget, nDataType)
Appends the source elements to a compatible dynamic target array.
| Parameter | Type | Description |
|---|---|---|
| hArySource | SalArray | The one-dimensional source array. |
| hAryTarget | SalArray | The compatible destination array. |
| nDataType | SalNumber | The SAL data-type code used for compatibility validation. |
Returns: SalNumber. The new target length; zero for an empty source; -1 if the target is not dynamic, the arrays are incompatible, or appending fails.
ArrayCopy(hArySource, hAryTarget, nDataType)
Copies a compatible one-dimensional source array into the target using the source bounds.
| Parameter | Type | Description |
|---|---|---|
| hArySource | SalArray | The one-dimensional source array. |
| hAryTarget | SalArray | The compatible destination array. |
| nDataType | SalNumber | The SAL data-type code used for compatibility validation. |
Returns: SalNumber. The copied length; zero for an empty source; -1 on incompatibility or failure.
An empty source resets a dynamic target and leaves a fixed target unchanged.
ArrayDeleteItem(hArray, nIndex, nDataType)
Removes the element at an array index and shifts subsequent elements.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray | The array to search or modify. |
| nIndex | SalNumber | The array or list index to operate on. |
| nDataType | SalNumber | Reserved for compatibility; this argument is ignored. |
Returns: SalNumber. The remaining length; VTERR_InvalidParameter for an invalid index; -1 for an empty or multidimensional array or another failure.
ArrayFillDateTime(dtArray, dtValue, nCount)
Fills the requested number of array elements with a value.
| Parameter | Type | Description |
|---|---|---|
| dtArray | SalArray<SalDateTime> | The date/time array to fill. |
| dtValue | SalDateTime | The date/time value to assign. |
| nCount | SalNumber | The number of array elements to fill. |
Returns: SalBoolean. The result returned by the SAL array Fill operation.
ArrayFillNumber(nArray, nValue, nCount)
Fills the requested number of array elements with a value.
| Parameter | Type | Description |
|---|---|---|
| nArray | SalArray<SalNumber> | The numeric array to fill. |
| nValue | SalNumber | The numeric value to assign or modify. |
| nCount | SalNumber | The number of array elements to fill. |
Returns: SalBoolean. The result returned by the SAL array Fill operation.
ArrayFillString(sArray, sValue, nCount)
Fills the requested number of array elements with a value.
| Parameter | Type | Description |
|---|---|---|
| sArray | SalArray<SalString> | The string array to fill. |
| sValue | SalString | The string value to assign. |
| nCount | SalNumber | The number of array elements to fill. |
Returns: SalBoolean. The result returned by the SAL array Fill operation.
ArrayFindDateTime(hArray, dtSearchFor)
Finds the first matching value in a one-dimensional array.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray<SalDateTime> | The array to search or modify. |
| dtSearchFor | SalDateTime | The date/time value to find. |
Returns: SalNumber. The matching element index, or -1 for no match or a multidimensional array.
Date/time matching compares tick values.
ArrayFindNumber(hArray, nSearchFor)
Finds the first matching value in a one-dimensional array.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray<SalNumber> | The array to search or modify. |
| nSearchFor | SalNumber | The number to find. |
Returns: SalNumber. The matching element index, or -1 for no match or a multidimensional array.
ArrayFindNumber(hArray, bSearchFor)
Finds the first matching value in a one-dimensional array.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray<SalBoolean> | The array to search or modify. |
| bSearchFor | SalBoolean | The Boolean value to find. |
Returns: SalNumber. The matching element index, or -1 for no match or a multidimensional array.
ArrayFindString(hArray, sSearchFor)
Finds the first matching value in a one-dimensional array.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray<SalString> | The array to search or modify. |
| sSearchFor | SalString | The text to find using ordinal comparison that ignores case. |
Returns: SalNumber. The matching element index, or -1 for no match or a multidimensional array.
String matching ignores case using ordinal comparison; date matching compares ticks.
ArrayInsertItem(hArray, nIndex, nDataType)
Inserts a default element at an array index.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray | The array to search or modify. |
| nIndex | SalNumber | The array or list index to operate on. |
| nDataType | SalNumber | The SAL data type used to initialize the inserted element. |
Returns: SalNumber. The new length; VTERR_InvalidParameter for an invalid index; -1 for another failure.
For compatibility, inserting at index zero into an empty dynamic array creates an additional empty element. Numeric elements are initialized to SalNumber.Null.
ArraySort(hArray, nSortOrder, nDataType)
Sorts array elements using Visual Toolchest comparison rules.
| Parameter | Type | Description |
|---|---|---|
| hArray | SalArray | The array to search or modify. |
| nSortOrder | SalNumber | SORT_Descending for descending order; any other value selects ascending order. |
| nDataType | SalNumber | Reserved for compatibility; this argument is ignored. |
Returns: SalNumber. The array length after sorting.
DosBuildFullName(sModuleName, sFileName)
Combines a loaded module's directory with a file name.
| Parameter | Type | Description |
|---|---|---|
| sModuleName | SalString | The name of a loaded module. |
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalString. The combined path, or SalString.Null when the module or its path cannot be resolved.
DosEnumDirInfo(sDirSpec, sDirs, dtDateTimes, nAttributes)
Enumerates matching subdirectory names, creation times, and attributes into parallel arrays.
| Parameter | Type | Description |
|---|---|---|
| sDirSpec | SalString | The directory path and wildcard name pattern. |
| sDirs | SalArray<SalString> | Receives matching directory names. |
| dtDateTimes | SalArray<SalDateTime> | Receives creation times in the same order as the names. |
| nAttributes | SalArray<SalNumber> | The file attribute mask, or the parallel output attribute array for enumeration. |
Returns: SalNumber. The matching directory count; zero when the directory has no subdirectories; a negative error code on failure or a nonempty unmatched directory.
DosEnumDirs(sDirSpec, sDirs)
Enumerates subdirectory names matching a path pattern.
| Parameter | Type | Description |
|---|---|---|
| sDirSpec | SalString | The directory path and wildcard name pattern. |
| sDirs | SalArray<SalString> | Receives matching directory names. |
Returns: SalNumber. The number of matches, or a negative error code when no match exists or enumeration fails.
DosEnumDrives(sDrives)
Enumerates logical drive paths into an array.
| Parameter | Type | Description |
|---|---|---|
| sDrives | SalArray<SalString> | Receives logical drive paths. |
Returns: SalNumber. The drive count, or a negative system error code.
DosEnumFileInfo(sFileSpec, nAttribute, sFiles, nSizes, dtDateTimes, nAttributes)
Enumerates matching file names, byte sizes, creation times, and attributes into parallel arrays.
| Parameter | Type | Description |
|---|---|---|
| sFileSpec | SalString | The file or directory path, optionally containing a wildcard filename. |
| nAttribute | SalNumber | The attribute filter; FA_Standard accepts all files, otherwise any matching attribute bit qualifies. |
| sFiles | SalArray<SalString> | Receives the matching file names without their parent directory. |
| nSizes | SalArray<SalNumber> | Receives file sizes in bytes. |
| dtDateTimes | SalArray<SalDateTime> | Receives creation times in the same order as the names. |
| nAttributes | SalArray<SalNumber> | The file attribute mask, or the parallel output attribute array for enumeration. |
Returns: SalNumber. The qualifying file count, or a negative error code when no filename matches or enumeration fails.
DosEnumFiles(sFileSpec, nAttributes, sFiles)
Enumerates file names matching a path pattern and attribute filter.
| Parameter | Type | Description |
|---|---|---|
| sFileSpec | SalString | The file or directory path, optionally containing a wildcard filename. |
| nAttributes | SalNumber | FA_Standard to accept all files; otherwise, an attribute mask requiring any matching bit. |
| sFiles | SalArray<SalString> | Receives the matching file names without their parent directory. |
Returns: SalNumber. The qualifying file count, or a negative error code when no filename matches or enumeration fails.
DosEnumNetConnections(sDevices, sNetNames)
Enumerates mapped network drives and their remote names.
| Parameter | Type | Description |
|---|---|---|
| sDevices | SalArray<SalString> | Receives local mapped device names. |
| sNetNames | SalArray<SalString> | Receives corresponding remote network names. |
Returns: SalNumber. The number of network connections, or zero for multidimensional output arrays.
DosEnumPath(sDirs)
Enumerates existing directories from the PATH environment variable.
| Parameter | Type | Description |
|---|---|---|
| sDirs | SalArray<SalString> | Receives qualifying PATH directories with a trailing separator. |
Returns: SalNumber. The number of included paths, or a negative system error code.
Entries already ending in the directory separator are skipped. Included entries receive a trailing separator.
DosExist(sFileSpec)
Tests whether a path or wildcard pattern matches a file or directory.
| Parameter | Type | Description |
|---|---|---|
| sFileSpec | SalString | The file or directory path, optionally containing a wildcard filename. |
Returns: SalBoolean. True when a match exists; false for an empty path, no match, or an error.
DosGetCurDir(sDrive)
Gets the current process directory.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | Reserved for compatibility; this argument is ignored. |
Returns: SalString. The current directory path.
DosGetDriveSize(sDrive, nTotalSpace, nFreeSpace)
Reads the total and free byte counts of a logical drive.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | The drive path or drive component. |
| nTotalSpace | SalNumber | Receives the total drive size in bytes. |
| nFreeSpace | SalNumber | Receives the total free space in bytes. |
Returns: SalNumber. VTERR_Ok on success; VTERR_InvalidDrive when the drive cannot be read.
DosGetDriveType(sDrive)
Reads the logical drive type.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | The drive path or drive component. |
Returns: SalNumber. The drive type code, or zero for an empty, invalid, or unreadable drive.
DosGetEnvString(sKeyName)
Reads an environment variable by name.
| Parameter | Type | Description |
|---|---|---|
| sKeyName | SalString | The environment variable name. |
Returns: SalString. The variable value, or an empty string if it is not defined.
DosGetFlags()
Deprecated:
Provides the obsolete DOS-flags compatibility entry point.
Returns: SalNumber. Zero.
Logs that the operation is unsupported.
DosGetNetName(sDevice)
Resolves a mapped device to its remote network name.
| Parameter | Type | Description |
|---|---|---|
| sDevice | SalString | The local mapped device name. |
Returns: SalString. The network name, or an empty string when resolution fails.
DosGetVersion()
Gets the operating-system major version reported by the runtime.
Returns: SalNumber. The major version number.
DosGetVolumeLabel(sDrive)
Reads a drive's volume label.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | The drive path or drive component. |
Returns: SalString. The label, or an empty string if the drive cannot be read.
DosIsParent(sDirSpec)
Tests whether a directory contains any immediate subdirectories.
| Parameter | Type | Description |
|---|---|---|
| sDirSpec | SalString | The directory to inspect; an empty value selects the current directory. |
Returns: SalBoolean. True if at least one subdirectory exists; otherwise, false, including errors.
DosMakeAllDir(sDir)
Creates a directory and any missing parent directories.
| Parameter | Type | Description |
|---|---|---|
| sDir | SalString | The directory path or component. |
Returns: SalNumber. VTERR_Ok on success, or a negative system error code.
DosMakePath(sDrive, sDir, sBase, sExt)
Concatenates a drive, directory, base name, and extension.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | The drive path or drive component. |
| sDir | SalString | The directory path or component. |
| sBase | SalString | The filename without its extension. |
| sExt | SalString | The extension including its leading dot. |
Returns: SalString. The concatenated path.
The inputs must include any required separators and extension dot.
DosNetConnect(sDevice, sNetName, sPassword)
Maps a local device to a network resource.
| Parameter | Type | Description |
|---|---|---|
| sDevice | SalString | The local mapped device name. |
| sNetName | SalString | The remote network resource name. |
| sPassword | SalString | The password used to establish the connection. |
Returns: SalNumber. Zero on success, or the negated network error code.
DosNetDisconnect(sDevice, bForce)
Cancels a network device connection.
| Parameter | Type | Description |
|---|---|---|
| sDevice | SalString | The local mapped device name. |
| bForce | SalBoolean | True to request disconnection even when files are open. |
Returns: SalNumber. Zero on success, or the negated network error code.
DosSetFlags(nFlags, bState)
Deprecated:
Provides the obsolete DOS-flags compatibility setter.
| Parameter | Type | Description |
|---|---|---|
| nFlags | SalNumber | The operation flags. |
| bState | SalBoolean | True to set the selected flags; false to clear them. |
Returns: SalNumber. Zero.
Logs that the operation is unsupported and ignores its arguments.
DosSetVolumeLabel(sDrive, sLabel)
Changes a drive's volume label.
| Parameter | Type | Description |
|---|---|---|
| sDrive | SalString | The drive path or drive component. |
| sLabel | SalString | The new volume label. |
Returns: SalNumber. Zero on success, or the negated Windows error code.
DosSplitPath(sFileSpec, sDrive, sDir, sBase, sExt)
Splits a path into drive, directory, base filename, and extension.
| Parameter | Type | Description |
|---|---|---|
| sFileSpec | SalString | The file or directory path, optionally containing a wildcard filename. |
| sDrive | SalString | Receives the drive component including its colon. |
| sDir | SalString | Receives the directory component with a trailing separator when nonempty. |
| sBase | SalString | Receives the filename without its extension. |
| sExt | SalString | Receives the extension including its leading dot. |
Returns: SalNumber. Zero after assigning the output components.
The drive includes its colon, the directory ends with a separator when nonempty, and the extension includes its dot.
ErrorRecovery(sCaption)
Displays a recovery dialog offering Retry and Halt Application.
| Parameter | Type | Description |
|---|---|---|
| sCaption | SalString | The recovery dialog caption. |
Returns: SalNumber. The selected button action code.
FileAppend(sSourceFile, sTargetFile)
Appends the bytes of all matching source files to an existing target file.
| Parameter | Type | Description |
|---|---|---|
| sSourceFile | SalString | The source file path, optionally containing filename wildcards. |
| sTargetFile | SalString | The target path, with wildcard substitutions when supported. |
Returns: SalNumber. The number of appended files, or a negative error code.
FileClose(hFile)
Closes an open SAL file handle.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
Returns: SalNumber. VTERR_Ok on success, or a negative error code.
The handle argument is passed by value, so the caller's handle variable is not cleared.
FileCopy(sSourceFile, sTargetFile)
Copies matching source files to the target path or wildcard-derived names.
| Parameter | Type | Description |
|---|---|---|
| sSourceFile | SalString | The source file path, optionally containing filename wildcards. |
| sTargetFile | SalString | The target path, with wildcard substitutions when supported. |
Returns: SalNumber. The number of files copied, or a negative error code.
Existing target files are overwritten.
FileCreateTemp(sPrefix)
Creates an empty file with an unused name in the temporary directory.
| Parameter | Type | Description |
|---|---|---|
| sPrefix | SalString | The filename prefix; at most three characters are used. |
Returns: SalString. The path of the created file.
The name begins with a tilde, up to three prefix characters, and a hexadecimal counter.
FileDelete(sFileName)
Deletes files matching the supplied path pattern.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalNumber. The number of deleted files, or a negative error code.
FileExpand(sSourceFile, sTargetFile)
Deprecated:
Provides the unsupported compressed-file expansion entry point.
| Parameter | Type | Description |
|---|---|---|
| sSourceFile | SalString | The source file path, optionally containing filename wildcards. |
| sTargetFile | SalString | The target path, with wildcard substitutions when supported. |
Returns: SalNumber. This method does not return.
Always throws NotSupportedException.
FileFind(sFileName)
Searches the Windows search path for a file.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalString. The resolved full path, or SalString.Null when not found.
FileGetAttribute(sFileName)
Reads a file's attribute flags.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalNumber. The FileAttributes flags, or a negative error code.
FileGetSize(sFileName)
Reads a file's size in bytes.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalNumber. The byte count; zero for an empty filename; a negative error code for a null filename or file-system failure.
FileGetType(sFileName)
Classifies a file as system, program, associated document, or other.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
Returns: SalNumber. A FILETYPE_* value, or a negative error code.
Hidden or system attributes take precedence over filename extensions and executable associations.
FileOpen(hFile, sFileName, nFlags)
Opens a SAL file, searching the Windows search path when creation is not requested.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | Receives the opened file handle. |
| sFileName | SalString | The file path or pattern, as required by the operation. |
| nFlags | SalNumber | The operation flags. |
Returns: SalNumber. VTERR_Ok on success, or a negative error code.
FileRead(hFile, sBuffer, nSize)
Reads data from an open SAL file into a buffer.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
| sBuffer | SalString | Receives the data read from the file. |
| nSize | SalNumber | The requested transfer size passed to the SAL file operation. |
Returns: SalNumber. The amount read, or a negative error code; zero can indicate end of file.
FileReadString(hFile, sLine)
Reads up to 8192 characters, stopping at a CR/LF line ending.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
| sLine | SalString | Receives the line after a successful read. |
Returns: SalNumber. VTERR_Ok on success, VTERR_EndOfFile at end of file, or a negative file error code.
The CR/LF delimiter is omitted. A lone line-feed is retained.
FileRename(sSourceFile, sTargetFile)
Moves or renames files matching the source pattern.
| Parameter | Type | Description |
|---|---|---|
| sSourceFile | SalString | The source file path, optionally containing filename wildcards. |
| sTargetFile | SalString | The target path, with wildcard substitutions when supported. |
Returns: SalNumber. The number of files moved, or a negative error code.
Target wildcard characters are expanded from the matching source names.
FileSeek(hFile, nOffset, nOrigin)
Moves the position of an open SAL file relative to the selected origin.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
| nOffset | SalNumber | The offset relative to the seek origin. |
| nOrigin | SalNumber | The SAL file seek origin code. |
Returns: SalNumber. The resulting file position, or a negative error code.
FileSetAttribute(sFileName, nAttributes, bState)
Sets or clears attribute bits on all matching files.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
| nAttributes | SalNumber | The file attribute bits to set or clear. |
| bState | SalBoolean | True to set the selected flags; false to clear them. |
Returns: SalNumber. The number of updated files, or a negative error code.
FileSetDateTime(sFileName, dtDateTime)
Sets the last-write time of all matching files.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
| dtDateTime | SalDateTime | The new last-write date/time. |
Returns: SalNumber. The number of updated files, or a negative error code.
FileTell(hFile)
Gets the current position of an open SAL file.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
Returns: SalNumber. The current position, or a negative error code.
FileWrite(hFile, sBuffer, nSize)
Writes a buffer to an open SAL file.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
| sBuffer | SalString | The buffer to read or write. |
| nSize | SalNumber | The requested transfer size passed to the SAL file operation. |
Returns: SalNumber. The amount written, or a negative error code.
FileWriteString(hFile, sLine)
Writes a line to an open SAL file using the SAL file-string operation.
| Parameter | Type | Description |
|---|---|---|
| hFile | SalFileHandle | The open SAL file handle. |
| sLine | SalString | The line to read or write. |
Returns: SalNumber. VTERR_Ok on success, or a negative error code.
FontEnum(nType, sNames, nTypes)
Enumerates available font family names and reports each as TrueType.
| Parameter | Type | Description |
|---|---|---|
| nType | SalNumber | Reserved for compatibility; this argument is ignored. |
| sNames | SalArray<SalString> | Receives available font family names. |
| nTypes | SalArray<SalNumber> | Receives FONTTYPE_TrueType for each font name. |
Returns: SalNumber. The font count; the Web implementation returns zero for multidimensional output arrays.
FontFree(hFont)
Releases a font handle returned by FontLoad.
| Parameter | Type | Description |
|---|---|---|
| hFont | SalNumber | The font handle created by FontLoad. |
Returns: SalBoolean. True if the handle is released; otherwise, false.
FontGet(hFont, sFaceName, nPointSize, nFontFlags)
Reads the family name, point size, and enhancement flags of a font handle.
| Parameter | Type | Description |
|---|---|---|
| hFont | SalNumber | The font handle created by FontLoad. |
| sFaceName | SalString | Receives the font family name. |
| nPointSize | SalNumber | Receives the size in points. |
| nFontFlags | SalNumber | Receives the FONT_Enh* style flags. |
Returns: SalBoolean. True if the font information is obtained; otherwise, false.
FontLoad(sFaceName, nPointSize, nEnhFlags)
Creates a font and registers a handle for later use by Visual Toolchest functions.
| Parameter | Type | Description |
|---|---|---|
| sFaceName | SalString | The font family name. |
| nPointSize | SalNumber | The font size in points. |
| nEnhFlags | SalNumber | The FONT_Enh* style flags used to create the font. |
Returns: SalNumber. The font handle, or SalNumber.Null if font creation yields no font.
Release the returned handle with FontFree.
GetCommonDir(ctrl, nIndex)
Reconstructs the directory path represented by an entry populated by PopulateCommonDir.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalString. The path ending in a separator; an empty string for an unsupported control, or SalString.Null for an invalid item.
GetCopyright()
Reads the executing assembly's copyright attribute.
Returns: SalString. The copyright text.
Throws InvalidOperationException when the attribute is missing.
GetKeyState(virtKey)
Reads the supported modifier and lock-key flags exposed by the Web control system.
| Parameter | Type | Description |
|---|---|---|
| virtKey | SalNumber | The virtual-key code to inspect. |
Returns: SalNumber. KS_Down and, for recognized lock keys, KS_LockOn when the corresponding modifier flag is present; otherwise, zero.
Other key codes return zero.
GetVersion()
Formats the Visual Toolchest compatibility version from the executing assembly version.
Returns: SalString. The version formatted as 9.major.minor-revision.build.
GetWinVersion()
Gets the operating-system major version reported by the runtime.
Returns: SalNumber. The major version number.
ListAddColor(ctrl, sText, nColor)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| nColor | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddColorValue(ctrl, sText, nColor, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| nColor | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddFont(ctrl, sText, hFont)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| hFont | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddFontValue(ctrl, sText, hFont, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| hFont | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddPicture(ctrl, sText, hPicNormal, hPicSelected)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddPictureValue(ctrl, sText, hPicNormal, hPicSelected, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sText | SalString | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListAddValue(ctrl, sText, nValue)
Appends a list item containing text and an associated numeric value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| sText | SalString | The displayed item text. |
| nValue | SalNumber | The numeric value to assign or modify. |
Returns: SalNumber. The inserted item index, or LB_Err for an unsupported control.
ListArrayPopulate(ctrl, sTexts)
Replaces the items of a list or combo box with the supplied strings.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| sTexts | SalArray<SalString> | The item texts in order. |
Returns: SalNumber. The number of supplied strings, or LB_Err for an unsupported control.
ListArrayPopulateValue(ctrl, sTexts, nValues)
Replaces a SAL list with parallel text and numeric-value arrays.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| sTexts | SalArray<SalString> | The item texts in order. |
| nValues | SalArray<SalNumber> | The parallel numeric item values. |
Returns: SalNumber. The number of supplied items, or LB_Err for an unsupported control or unequal lengths.
The arrays must have equal lengths and support zero-based indexing.
ListClearSelection(ctrl)
Clears the current selection of a list or combo box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalBoolean. True for a supported list control; otherwise, false.
ListCollapse(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListDeleteChild(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListDeleteDescendents(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListDeleteSelected(ctrl)
Clears the current selection and removes items identified by the selected-index collection.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalNumber. The remaining item count; zero for an unsupported or empty control; VTERR_InvalidParameter for a null control.
The selected-index collection is captured before clearing SelectedIndex. Controls exposing a live collection can therefore have no indices left to delete.
ListDemote(ctrl, nIndex, hPicNormal, hPicSelect)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListDisableItem(ctrl, nIndex, nColor)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| nColor | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListDragDrop(ctrl, sourceIndex, targetCtrl, targetIndex, dropFlags)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sourceIndex | SalNumber | |
| targetCtrl | Control | |
| targetIndex | SalNumber | |
| dropFlags | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListEnableItem(ctrl, nIndex, nColor)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| nColor | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListEnumChildren(item, items)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| items | SalArray<SalNumber> |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListEnumDescendents(item, items)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| items | SalArray<SalNumber> |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListExpand(ctrl, index)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| index | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListExpandDescendents(ctrl, index)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| index | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns (the Boolean conversion of Sys.LB_Err).
ListFindItemValue(item, value)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| value | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns false.
ListFindString(ctrl, nStartIndex, sText)
Finds a matching list item after the starting index, wrapping to the beginning when necessary.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nStartIndex | SalNumber | The index after which to start searching; -1 begins with the first item. |
| sText | SalString | The displayed item text. |
Returns: SalNumber. The matching index, or -1 when no item matches; VTERR_InvalidParameter for a null control.
ListFindValue(ctrl, nStartIndex, nValue)
Finds an item by its associated numeric value, wrapping to the beginning when necessary.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nStartIndex | SalNumber | The index after which to start searching; -1 begins with the first item. |
| nValue | SalNumber | The numeric value to assign or modify. |
Returns: SalNumber. The matching index, or LB_Err when no match or supported list is available.
ListFreeChild(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListFreeDescendents(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListGetColor(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetDropdownState(ctrl)
Tests whether a combo box dropdown is currently open.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalBoolean. True if the combo dropdown is open; otherwise, false.
ListGetFlags(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetFocusIndex(ctrl)
Gets the selected index of a Web list box or the current SAL list selection.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalNumber. The selected index, or VTERR_InvalidParameter for a null control.
ListGetFont(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetItemColor(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetItemData(item, sText, nValue, nItemFlags)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| sText | SalString | |
| nValue | SalNumber | |
| nItemFlags | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListGetItemFlags(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns false.
ListGetItemFont(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetItemHandle(ctrl, index)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| index | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetItemIndex(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetItemPicture(item, hPicNormal, hPicSelect)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListGetItemText(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalString. If the list extension cannot be resolved, returns SalString.Null.
ListGetItemValue(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetLevel(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetNextSibling(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetParent(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetPicture(ctrl, nIndex, hPicNormal, hPicSelected)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListGetPrevSibling(item)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetRoot(ctrl)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
Returns: SalNumber. If the list extension cannot be resolved, returns SalNumber.Null.
ListGetStyle(ctrl)
Reads the supported Visual Toolchest style flags from a list, combo box, or tree.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalNumber. The translated style flags including LBS_VisExtensions; zero for an unsupported or null control.
ListGetText(ctrl, nIndex)
Reads an item's display text from a list or combo box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalString. The item text, or an empty string when no item is obtained.
ListGetValue(ctrl, nIndex)
Reads the numeric value associated with a SAL list item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalNumber. The value; zero for a non-Visual-Toolchest item or unsupported non-null control; LB_Err for a missing item; VTERR_InvalidParameter for a null control.
ListInsertColor(ctrl, nIndex, sText, nColor)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| nColor | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertColorValue(ctrl, nIndex, sText, nColor, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| nColor | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertFont(ctrl, nIndex, sText, hFont)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| hFont | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertFontValue(ctrl, nIndex, sText, hFont, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| hFont | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertPicture(ctrl, nIndex, sText, hPicNormal, hPicSelected)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertPictureValue(ctrl, nIndex, sText, hPicNormal, hPicSelected, nValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| sText | SalString | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber | |
| nValue | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListInsertValue(ctrl, nIndex, sText, nValue)
Inserts a list item with text and an associated numeric value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
| sText | SalString | The displayed item text. |
| nValue | SalNumber | The numeric value to assign or modify. |
Returns: SalNumber. The inserted index; LB_Err for an unsupported list; VTERR_InvalidParameter for a null control.
ListIsMultiSelect(ctrl)
Tests whether the list permits multiple selections.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalBoolean. True for MultiSimple or MultiExtended selection mode; otherwise, false.
ListLoadChild(ctrl, hItemParent, hPicNormal, hPicSelect, sText, nValue, nItemFlags)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| hItemParent | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber | |
| sText | SalString | |
| nValue | SalNumber | |
| nItemFlags | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListLoadChildren(ctrl, hItemParent, hPicNormal, hPicSelected, sTexts, nValues, nItemFlags)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| hItemParent | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber | |
| sTexts | SalArray<SalString> | |
| nValues | SalArray<SalNumber> | |
| nItemFlags | SalArray<SalNumber> |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListLoadOutline(ctrl, sBlob)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sBlob | SalString |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListLoadOutlineFile(ctrl, sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sFileName | SalString | |
| hPicParentNormal | SalNumber | |
| hPicParentSelect | SalNumber | |
| hPicChildNormal | SalNumber | |
| hPicChildSelect | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListLoadSibling(ctrl, hItemBefore, hPicNormal, hPicSelect, sText, nValue, nItemFlags)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| hItemBefore | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber | |
| sText | SalString | |
| nValue | SalNumber | |
| nItemFlags | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListMoveDown(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns 0.
ListMoveUp(ctrl, nIndex)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns 0.
ListPromote(ctrl, nIndex, hPicNormal, hPicSelect)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns 0.
ListSaveOutline(ctrl, sBlob)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| sBlob | SalString |
Returns: SalNumber. If the list extension cannot be resolved, returns 0.
ListScroll(ctrl, nIndex)
Requests scrolling to a list index or ensures an outline node is visible.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalNumber. One if the scroll or ensure-visible operation succeeds; zero if unsupported or unsuccessful; VTERR_InvalidParameter for a null control.
For a Web ListBox, the top-index message is sent with zero as its numeric parameter and the requested index as its secondary parameter. Outline controls use the requested index to find the node.
ListSetColor(ctrl, nIndex, nColor)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| nColor | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetDropdownState(ctrl, bState)
Accepts a combo dropdown-state request.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| bState | SalBoolean | True to set the selected flags; false to clear them. |
Returns: SalBoolean. True for a combo box; otherwise, false.
This Web implementation validates the control but does not change DroppedDown.
ListSetFlags(ctrl, nIndex, nItemFlags, bState)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| nItemFlags | SalNumber | |
| bState | SalBoolean |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListSetFocusIndex(ctrl, nIndex)
Moves the list caret or selection to an item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalNumber. The native caret-operation result for a multiselect list box; otherwise LB_Ok on successful selection or LB_Err.
ListSetFont(ctrl, nIndex, hFont)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| hFont | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns (the Boolean conversion of Sys.LB_Err).
ListSetItemColor(item, nColor)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| nColor | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetItemData(ctrl, item, sText, nValue, nItemFlags)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| item | SalNumber | |
| sText | SalString | |
| nValue | SalNumber | |
| nItemFlags | SalNumber |
Returns: SalNumber. If the list extension cannot be resolved, returns Sys.LB_Err.
ListSetItemFlags(item, nItemFlags, bState)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| nItemFlags | SalNumber | |
| bState | SalBoolean |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetItemFont(item, hFont)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| hFont | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetItemPicture(item, hPicNormal, hPicSelect)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelect | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetItemText(item, sText)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| sText | SalString |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetItemValue(item, nValue)
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| nValue | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
ListSetOutlineRedraw(ctrl, bRedraw)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| bRedraw | SalBoolean |
Returns: SalBoolean. If the list extension cannot be resolved, returns 0.
ListSetPicture(ctrl, nIndex, hPicNormal, hPicSelected)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nIndex | SalNumber | |
| hPicNormal | SalNumber | |
| hPicSelected | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns (the Boolean conversion of Sys.LB_Err).
ListSetScrollWidth(ctrl, nIndex)
Accepts the horizontal list extent compatibility request.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalNumber. Zero for a list box with a negative index; otherwise LB_Err, or VTERR_InvalidParameter for a null control. Invalid item indices can throw.
The Web implementation does not change the extent.
ListSetStyle(ctrl, nStyle, lParam)
Applies Visual Toolchest list style flags to a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nStyle | SalNumber | The Visual Toolchest list style flags. |
| lParam | SalNumber | Reserved for compatibility; this argument is ignored. |
Returns: SalBoolean. The result of applying the list style.
ListSetText(ctrl, nIndex, sText)
Changes the displayed text of a list or combo item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
| sText | SalString | The displayed item text. |
Returns: SalNumber. Zero after assignment or for an unsupported non-null control; LB_Err for a missing SAL item; VTERR_InvalidParameter for a null control.
ListSetValue(ctrl, nIndex, nValue)
Changes an item's associated numeric value, wrapping a plain item when necessary.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
| nValue | SalNumber | The numeric value to assign or modify. |
Returns: SalNumber. Zero after processing, including unsupported non-null controls; LB_Err for a missing item; VTERR_InvalidParameter for a null control.
ListShowOutline(ctrl, nLevel)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control containing the Visual Toolchest list or outline. |
| nLevel | SalNumber |
Returns: SalBoolean. If the list extension cannot be resolved, returns false.
MenuCheck(ctrl, hMenu, nPos)
Checks a menu item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item is found and updated; otherwise, false.
MenuDelete(ctrl, hMenu, nPos)
Removes an item from its parent menu.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item and its parent are found and the item is removed; otherwise, false.
MenuDisable(ctrl, hMenu, nPos)
Disables a menu item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item is found and updated; otherwise, false.
MenuEnable(ctrl, hMenu, nPos)
Enables a menu item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item is found and updated; otherwise, false.
MenuGetCount(ctrl, hMenu)
Counts the immediate items in a menu.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
Returns: SalNumber. The item count, or -1 if the menu cannot be resolved.
MenuGetHandle(ctrl)
Gets the current main-menu handle of a form.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The form whose current main menu is requested. |
Returns: SalNumber. The menu handle, or zero if the control is not a form or has no current menu.
MenuGetPopupHandle(ctrl, hMenu, nPos)
Gets a menu item's handle when it contains a submenu.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalNumber. The popup handle, or zero if the item is absent or has no child items.
MenuGetSystemHandle(hWnd)
Deprecated:
Accepts a system-menu compatibility request.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalNumber. Zero.
This operation is unsupported and logs that limitation.
MenuGetText(ctrl, hMenu, nPos)
Reads a menu item's caption and displayed keyboard shortcut.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalString. The item text, or an empty string if the item cannot be found.
A visible shortcut is appended after a tab for a leaf item.
MenuInsert(ctrl, hMenu, nPos, sText, nFlags)
Inserts an item at a menu position or appends it.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based insertion position, including the item count, or -1 to append. |
| sText | SalString | The menu-item caption. |
| nFlags | SalNumber | The menu-item creation flags. |
Returns: SalNumber. The negative menu identifier, usable as an item selector in other menu functions; SalNumber.Null for an unresolved menu or invalid position.
MenuInsertFont(ctrl, hMenu, nPos, hFont, sText)
Inserts a menu item with a registered font.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based insertion position less than the current item count, or -1 to append. |
| hFont | SalNumber | The registered font handle; ignored by the WinForms implementation. |
| sText | SalString | The menu-item caption. |
Returns: SalNumber. The negative menu identifier, or SalNumber.Null for an unresolved menu or invalid position.
MenuInsertPicture(ctrl, hMenu, nPos, hPicNormal, hPicSelected, sText)
Inserts a menu item with normal and selected pictures.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based insertion position less than the current item count, or -1 to append. |
| hPicNormal | SalNumber | The normal-state picture handle. |
| hPicSelected | SalNumber | The selected-state picture handle; ignored by WinForms MenuInsertPicture. |
| sText | SalString | The menu-item caption. |
Returns: SalNumber. The negative menu identifier, or SalNumber.Null for an unresolved menu or invalid position.
MenuIsChecked(ctrl, hMenu, nPos)
Tests whether a menu item is checked.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item exists and is checked; otherwise, false.
MenuIsEnabled(ctrl, hMenu, nPos)
Tests whether a menu item is enabled.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item exists and is enabled; otherwise, false.
MenuSetFont(ctrl, hMenu, nPos, hFont, sText)
Changes the caption and font of a SAL menu item.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
| hFont | SalNumber | The registered font handle; ignored by the WinForms implementation. |
| sText | SalString | The menu-item caption. |
Returns: SalBoolean. True if the item is found and updated; false if it cannot be found.
Throws InvalidOperationException if the resolved item is not a SalMenuItem.
MenuSetPicture(ctrl, hMenu, nPos, hPicNormal, hPicSelected, sText)
Changes a SAL menu item's caption and resolves the supplied picture handles.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
| hPicNormal | SalNumber | The normal-state picture handle. |
| hPicSelected | SalNumber | The selected-state picture handle. |
| sText | SalString | The menu-item caption. |
Returns: SalBoolean. True if the caption is updated; false if the item cannot be found.
The Web implementation does not assign the resolved images. Throws InvalidOperationException if the resolved item is not a SalMenuItem.
MenuSetText(ctrl, hMenu, nPos, sText)
Changes a menu item's caption.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
| sText | SalString | The menu-item caption. |
Returns: SalBoolean. True if the item is found and updated; otherwise, false.
MenuUncheck(ctrl, hMenu, nPos)
Clears a menu item's check mark.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control whose main or context menu is searched. |
| hMenu | SalNumber | The menu handle within the control's main or context menu. |
| nPos | SalNumber | The zero-based item position, or the negative identifier returned by a menu-insertion function. |
Returns: SalBoolean. True if the item is found and updated; otherwise, false.
MessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons)
Displays a message dialog using custom button handles and an optional default button.
| Parameter | Type | Description |
|---|---|---|
| sMsgText | SalString | The message text. |
| sCaption | SalString | The recovery dialog caption. |
| hPicIcon | SalNumber | The picture handle or message-box icon constant. |
| hBtnHandles | SalArray<SalNumber> | The custom button handles in display order. |
| nNumButtons | SalNumber | The number of button handles to use. |
Returns: SalNumber. The return value associated with the chosen button.
The overload without a default-button index selects index zero.
MessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons, nDefButtonIndex)
Displays a message dialog using custom button handles and an optional default button.
| Parameter | Type | Description |
|---|---|---|
| sMsgText | SalString | The message text. |
| sCaption | SalString | The recovery dialog caption. |
| hPicIcon | SalNumber | The picture handle or message-box icon constant. |
| hBtnHandles | SalArray<SalNumber> | The custom button handles in display order. |
| nNumButtons | SalNumber | The number of button handles to use. |
| nDefButtonIndex | SalNumber | The zero-based default-button index. |
Returns: SalNumber. The return value associated with the chosen button.
The overload without a default-button index selects index zero.
MessageFreeButton(hBtn)
Releases a custom message-box button handle.
| Parameter | Type | Description |
|---|---|---|
| hBtn | SalNumber | The custom button handle to release. |
Returns: SalBoolean. True if the registered handle is released; otherwise, false.
MessageLoadButton(sLabel, nReturn)
Registers a custom message-box button with its label and return value.
| Parameter | Type | Description |
|---|---|---|
| sLabel | SalString | The text displayed on the custom button. |
| nReturn | SalNumber | The value returned when this button is selected. |
Returns: SalNumber. The registered button handle.
Release the returned handle with MessageFreeButton after use.
NumberBitClear(nValue, nBitMask)
Clears selected bits in an unsigned 32-bit representation of a number.
| Parameter | Type | Description |
|---|---|---|
| nValue | SalNumber | The numeric value to assign or modify. |
| nBitMask | SalNumber | The unsigned 32-bit mask selecting bits. |
Returns: SalNumber. The updated value, also assigned to the reference parameter.
NumberBitSet(nValue, nBitMask)
Sets selected bits in an unsigned 32-bit representation of a number.
| Parameter | Type | Description |
|---|---|---|
| nValue | SalNumber | The numeric value to assign or modify. |
| nBitMask | SalNumber | The unsigned 32-bit mask selecting bits. |
Returns: SalNumber. The updated value, also assigned to the reference parameter.
NumberChoose(bExpression, nTrue, nFalse)
Selects one of two numbers according to a Boolean expression.
| Parameter | Type | Description |
|---|---|---|
| bExpression | SalBoolean | The condition that selects the result. |
| nTrue | SalNumber | The value returned for a true condition. |
| nFalse | SalNumber | The value returned for a false condition. |
Returns: SalNumber. The true value if the expression is true; otherwise, the false value.
NumberHighByte(nNumber)
Extracts bits 8 through 15 from a number.
| Parameter | Type | Description |
|---|---|---|
| nNumber | SalNumber | The number whose low word is examined. |
Returns: SalNumber. The high byte of the low 16-bit word.
NumberLowByte(nNumber)
Extracts bits 0 through 7 from a number.
| Parameter | Type | Description |
|---|---|---|
| nNumber | SalNumber | The number whose low word is examined. |
Returns: SalNumber. The low byte.
NumberMakeLong(nLowWord, nHighWord)
Combines the low 16 bits of two numbers into an unsigned 32-bit value.
| Parameter | Type | Description |
|---|---|---|
| nLowWord | SalNumber | The value supplying bits 0 through 15. |
| nHighWord | SalNumber | The value supplying bits 16 through 31. |
Returns: SalNumber. The high word shifted left by 16 bits and combined with the low word.
PicFree(hPic)
Releases a registered picture and its image resources.
| Parameter | Type | Description |
|---|---|---|
| hPic | SalNumber | The picture handle returned by PicLoad. |
Returns: SalNumber. VTERR_Ok after release; VTERR_InvalidParameter for zero; VTERR_InvalidHandle for an unknown handle.
PicLoad(flags, resource, imageName)
Loads a picture from a file, module resource, SAL resource, or binary SAL string.
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | The PIC_Load* source, size, and format flags. |
| resource | SalString | The source file, resource name, or binary picture data selected by the flags. |
| imageName | SalString | The named image within a module resource when applicable. |
Returns: SalNumber. The registered picture handle, or zero if no image is loaded.
The flags choose the source; recognized filename extensions also supply source and format flags. Release successful handles with PicFree.
PopulateCommonDir(ctrl, sDirectory)
Replaces a list with the directory path components and immediate subdirectories.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| sDirectory | SalString | The directory whose components or children are displayed. |
Returns: SalNumber. The resulting list count, including any entries added before an error; zero for an unsupported control.
Selects the last component of the supplied directory.
PopulateDirTree(ctrl, sDirectory)
Replaces an outline with a directory root and its immediate child directories.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| sDirectory | SalString | The directory whose components or children are displayed. |
Returns: SalNumber. The number of loaded nodes, or zero on failure.
Child entries are marked expandable; deeper levels are not loaded by this call.
PopulateDrives(ctrl)
Replaces a list with logical drives, drive icons, and available volume labels.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalNumber. The number of populated list items.
Selects the current drive when the populated list is nonempty.
PopulateFontNames(ctrl, nType)
Replaces a list with available font family names and a font icon.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nType | SalNumber | Reserved for compatibility; this argument is ignored. |
Returns: SalNumber. The number of populated items.
ProfileDelete(sFileName, sSection, sEntry)
Deletes an entry or an entire section from an INI file.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
| sSection | SalString | The INI section name. |
| sEntry | SalString | The entry name, or an empty value to remove the entire section. |
Returns: SalBoolean. True if the profile operation succeeds; otherwise, false.
ProfileEnumStrings(sFileName, sSection, sStrings)
Enumerates entry names in an INI-file section.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path or pattern, as required by the operation. |
| sSection | SalString | The INI section name. |
| sStrings | SalArray<SalString> | Receives the entry names. |
Returns: SalNumber. The entry count; zero for an empty section name; VTERR_FileNotFound if the file cannot be located.
The file is located using the Windows search path. Values following the equals sign are omitted.
SetCommonDir(ctrl, nIndex)
Repopulates a directory list using the path represented by the selected entry.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
| nIndex | SalNumber | The array or list index to operate on. |
Returns: SalString. The selected path if repopulation produces entries; otherwise, SalString.Null.
StrChoose(bExpression, sTrue, sFalse)
Selects one of two strings according to a Boolean expression.
| Parameter | Type | Description |
|---|---|---|
| bExpression | SalBoolean | The condition that selects the result. |
| sTrue | SalString | The string selected for a true condition. |
| sFalse | SalString | The string selected for a false condition. |
Returns: SalString. The true value when the condition is true; otherwise, the false value.
StrExpand(sTemplate, hArray)
Expands numeric, string, and index placeholders using an array.
| Parameter | Type | Description |
|---|---|---|
| sTemplate | SalString | The template containing Visual Toolchest percent placeholders. |
| hArray | SalArray | The array to search or modify. |
Returns: SalString. The expanded text; SalString.Null for an empty template or empty or multidimensional array; the original template for an unsupported element type.
%n formats numeric values as integers, %s inserts strings, %u inserts indices, and %% inserts a percent sign. Braced sections repeat for array elements; a comma after the percent sign separates repetitions.
StrFind(hTable, sKey)
Looks up a key in a loaded string table.
| Parameter | Type | Description |
|---|---|---|
| hTable | SalNumber | The string-table handle returned by StrLoadTable. |
| sKey | SalString | The key to find. |
Returns: SalString. The stored text, a null SAL string when the key is absent, or an empty string for a nonpositive handle.
StrFreeTable(hTable)
Clears a loaded string table and releases its runtime handle.
| Parameter | Type | Description |
|---|---|---|
| hTable | SalNumber | The string-table handle returned by StrLoadTable. |
Returns: SalBoolean. True for a positive handle after release; false for a nonpositive handle.
StrLeftTrim(sSource)
Removes leading whitespace from a string.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
Returns: SalString. The trimmed text, preserving an empty or null input.
StrLoadTable(sFilename)
Loads key/value string-table entries from a text file.
| Parameter | Type | Description |
|---|---|---|
| sFilename | SalString | The string-table text file to read. |
Returns: SalNumber. The registered string-table handle.
Duplicate keys replace earlier values. Release the resulting handle with StrFreeTable.
StrPad(sSource, nSize)
Pads or truncates a string to the requested length.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
| nSize | SalNumber | The desired character count. |
Returns: SalString. The resized string; a null SAL string for a negative length; a null input remains null.
Padding uses spaces on the right.
StrProper(sSource)
Applies Visual Toolchest proper-name capitalization.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
Returns: SalString. The converted string, preserving empty or null input.
Capitalizes after punctuation and whitespace and recognizes Mc, Mac, and O' prefixes. Character conversion uses the current culture.
StrRightTrim(sSource)
Removes trailing whitespace from a string.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
Returns: SalString. The trimmed text, preserving an empty or null input.
StrScanReverse(sSource, nPos, sSearch)
Searches backward for text using case-insensitive comparison.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
| nPos | SalNumber | The last starting index to inspect; -1 starts at the last possible match position. |
| sSearch | SalString | The substring to locate. |
Returns: SalNumber. The zero-based matching index, or -1 for no match or invalid input.
StrSubstitute(sSource, sSearch, sReplace)
Replaces every case-sensitive occurrence of a substring.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
| sSearch | SalString | The substring to locate. |
| sReplace | SalString | The replacement text, or null to delete matches. |
Returns: SalString. The substituted string.
A null replacement deletes matches. An empty search string leaves the source unchanged.
StrTrim(sSource)
Removes leading and trailing whitespace from a string.
| Parameter | Type | Description |
|---|---|---|
| sSource | SalString | The input string. |
Returns: SalString. The trimmed text, preserving an empty or null input.
TblAllRows(table, nFlagsOn, nFlagsOff)
Tests whether any table row matches the requested flags.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| nFlagsOn | SalNumber | The row flags that must be set. |
| nFlagsOff | SalNumber | The row flags that must be clear. |
Returns: SalBoolean. The result of Sal.TblAnyRows.
Despite the compatibility name, this delegates to Sal.TblAnyRows.
TblAutoSizeColumn(table, column)
Resizes a table column, or all columns when no valid column is supplied, with four pixels of padding.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
Returns: SalBoolean. True for a valid table; otherwise, false.
TblClearColumnSelection(table)
Clears the selected state of every table column.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
Returns: SalBoolean. True for a valid table; otherwise, false.
TblFindDateTime(table, row, column, date)
Finds the first table row whose specified column, or any column, equals a date/time value.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| row | SalNumber | The first row index included in the search. |
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
| date | SalDateTime | The date/time value to match. |
Returns: SalNumber. The matching row, or -1 for no match, an invalid table, or a null search value.
Searching fetches rows and changes the table context.
TblFindNumber(table, row, column, number)
Finds the first table row whose specified column, or any column, equals a number.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| row | SalNumber | The first row index included in the search. |
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
| number | SalNumber | The numeric value to match. |
Returns: SalNumber. The matching row, or -1 for no match, an invalid table, or a null search value.
Searching fetches rows and changes the table context.
TblFindString(table, row, column, pattern)
Finds the first table row containing the search text in the specified column or any column.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| row | SalNumber | The first row index included in the search. |
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
| pattern | SalString | The text to find within a cell. |
Returns: SalNumber. The matching row, or -1 for no match, an invalid table, or a null pattern.
Searching uses SalString.Scan, fetches rows, and changes the table context.
TblGetCell(table, nRow, column)
Reads a cell's displayed text while preserving the table context row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| nRow | SalNumber | The row index to read or change. |
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
Returns: SalString. The cell text, or SalString.Null for an invalid table, column, or row.
TblGetColumnTitle(column)
Reads the title of a SAL table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | The target column, or an invalid/null column to use all columns where supported. |
Returns: SalString. The title, or SalString.Null for an invalid column.
TblSetRowColor(table, nRow, nColor)
Sets the text color of every cell in a table row while preserving the context row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| nRow | SalNumber | The row index to read or change. |
| nColor | SalNumber | The SAL text color value. |
Returns: SalBoolean. True if the row is updated; otherwise, false.
TblSetRowPicture(table, rowFlags, handle)
Associates an image with row-header flags, replacing the previous image for those flags.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| rowFlags | SalNumber | The row flags associated with the header image. |
| handle | SalNumber | The valid picture handle registered by PicLoad. |
Returns: SalBoolean. True for a valid table after updating row headers; otherwise, false.
Image and image-source overloads remove the association when passed null. The picture-handle overload requires a valid picture handle.
TblSetRowPicture(table, rowFlags, image)
Associates an image with row-header flags, replacing the previous image for those flags.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| rowFlags | SalNumber | The row flags associated with the header image. |
| image | Image | The row-header image, or null to remove the association. |
Returns: SalBoolean. True for a valid table after updating row headers; otherwise, false.
Image and image-source overloads remove the association when passed null. The picture-handle overload requires a valid picture handle.
TblSetRowPicture(table, rowFlags, imageSource)
Associates an image with row-header flags, replacing the previous image for those flags.
| Parameter | Type | Description |
|---|---|---|
| table | Control | The SAL table control. |
| rowFlags | SalNumber | The row flags associated with the header image. |
| imageSource | String | The image source, or null to remove the association. |
Returns: SalBoolean. True for a valid table after updating row headers; otherwise, false.
Image and image-source overloads remove the association when passed null. The picture-handle overload requires a valid picture handle.
WaitCursor(nFlags)
Accepts a wait-cursor compatibility command.
| Parameter | Type | Description |
|---|---|---|
| nFlags | SalNumber | The wait-cursor command; ignored by the Web implementation. |
Returns: SalNumber. Zero.
This Web implementation does not change the cursor or track nesting.
WinClearAllEditFlags(parent)
Clears the Modified flag of data fields and multiline edit controls within a parent.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The parent control whose descendant inputs are examined. |
Returns: SalNumber. The number of processed controls, or -1 for an invalid parent.
WinClearAllFields(parent)
Clears supported data-entry controls, lists, and child tables within a parent.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The parent control whose descendant inputs are examined. |
Returns: SalNumber. The number of processed controls, or -1 for an invalid parent.
WinFreeAccelerator(hAccel)
Disposes a keyboard accelerator registered by WinLoadAccelerator.
| Parameter | Type | Description |
|---|---|---|
| hAccel | SalNumber | The registered keyboard accelerator handle. |
Returns: SalBoolean. True if the accelerator is found and disposed; otherwise, false.
WinGetFlags(hWnd)
Reads the Visual Toolchest flags associated with a window.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalNumber. The stored flags, or zero when none are available.
WinGetHandle(ctrl, sText, nType)
Finds the first child of a form matching a SAL window type and exact text.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The target window or control. |
| sText | SalString | The exact window text to match. |
| nType | SalNumber | The SAL window type to match. |
Returns: SalWindowHandle. The matching control handle, or a null handle if no match or form is available.
WinGetProp(hWnd, propName)
Reads a numeric property from a Web control's user-data collection.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
| propName | SalString | The property name. |
Returns: SalNumber. The stored SalNumber, or zero for an absent or incompatible value, empty name, or null handle.
WinGetStyle(hWnd)
Builds the supported window-style flags from Web control properties.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalNumber. The supported style flags, or -1 for a null handle.
Only WS_TABSTOP and WS_DISABLED are represented.
WinGetText(ctrl)
Gets the text exposed by the SAL window abstraction.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The list, combo box, or Visual Toolchest outline control. |
Returns: SalString. The control text.
WinIsChild(hWndParent, hWndChild)
Tests whether one control contains another control.
| Parameter | Type | Description |
|---|---|---|
| hWndParent | SalWindowHandle | The potential parent window. |
| hWndChild | SalWindowHandle | The potential descendant window. |
Returns: SalBoolean. True if the second control belongs to the first control's descendant hierarchy; otherwise, false.
WinIsMaximized(hWnd)
Tests whether a form is maximized.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalBoolean. True for a maximized form; otherwise, false.
WinIsMinimized(hWnd)
Tests whether a form is minimized.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalBoolean. True for a minimized form; otherwise, false.
WinIsRequiredFieldNull(parent)
Finds the first empty input control marked WF_Required.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The parent control whose descendant inputs are examined. |
Returns: SalWindowHandle. The first empty required control, or a null handle if none is found.
Checks data fields, multiline edits, lists, and combo boxes.
WinIsRestored(hWnd)
Tests whether a valid window is neither minimized nor maximized.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalBoolean. True if the window is valid and in neither state; otherwise, false.
WinIsWindow(hWnd)
Tests whether a handle resolves to a control.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
Returns: SalBoolean. True if a control is available; otherwise, false.
WinLoadAccelerator(target, nMessage, nKeyState, nKey, nID)
Registers a key combination that sends a message and identifier to a target control.
| Parameter | Type | Description |
|---|---|---|
| target | Control | The control that receives the accelerator message. |
| nMessage | SalNumber | The message identifier to send. |
| nKeyState | SalNumber | The KDS_* shift, control, and alt modifier flags. |
| nKey | SalNumber | The virtual-key code. |
| nID | SalNumber | The identifier delivered with the accelerator message. |
Returns: SalNumber. The accelerator handle.
Release the returned handle with WinFreeAccelerator.
WinMove(hWnd, nLeft, nTop, nWidht, nHeight)
Changes a control's position and size.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
| nLeft | SalNumber | The left coordinate in pixels. |
| nTop | SalNumber | The top coordinate in pixels. |
| nWidht | SalNumber | The width in pixels. |
| nHeight | SalNumber | The height in pixels. |
Returns: SalBoolean. True if the control is resolved and its bounds are assigned; otherwise, false.
WinSetFlags(hWnd, winFlags, state)
Sets or clears Visual Toolchest window flags and applies display-only behavior.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
| winFlags | SalNumber | The Visual Toolchest window flags to change. |
| state | SalBoolean | True to set the selected bits; false to clear them. |
Returns: SalBoolean. True after updating a valid control; false for a null or unresolved handle or a negative mask being enabled.
WF_DisplayOnly updates tab-stop and read-only or enabled properties according to the control type.
WinSetProp(hWnd, propName, propValue)
Stores a numeric property in a Web control's user-data collection.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
| propName | SalString | The property name. |
| propValue | SalNumber | The numeric value to associate with the window. |
Returns: SalBoolean. True after assignment; false for a null handle or empty name.
WinSetStyle(hWnd, style, state)
Applies supported style flags through Web control properties.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The target window handle. |
| style | SalNumber | The window style bits to change. |
| state | SalBoolean | True to set the selected bits; false to clear them. |
Returns: SalBoolean. True for a non-null handle after processing; otherwise, false.
WS_TABSTOP changes TabStop and WS_DISABLED changes Enabled. Other style bits are ignored.
WinSetTabOrder(ctrl, ctrlAfter)
Places a control after another control in tab-index order or removes its tab stop.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The target window or control. |
| ctrlAfter | Control | The control to follow in tab order, or null to disable the target tab stop. |
Returns: SalBoolean. True for a valid target control; otherwise, false.
A null reference control clears TabStop. Otherwise only TabIndex is changed; TabStop is not automatically reenabled.
WinShow(ctrl, nShowCmd)
Shows, hides, minimizes, maximizes, or restores a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The target window or control. |
| nShowCmd | SalNumber | The SHOW_* command. |
Returns: SalBoolean. True for a valid control; otherwise, false.
Minimizing a non-form hides it; maximizing a child control fills its parent. Unknown commands make no change.