Vis

PPJ.Runtime.Vis.Vis

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)

Contains all Vis.* static functions and constants.

public class Vis

Fields

Name
Type
Description

ACTION_Abort

abort

ACTION_Retry

retry

CAL_AlternateButtons

Not used.

CAL_EnableButtons

Not used.

CAL_EnableKeyboard

Not used.

CAL_EtchedLook

CAL_MultiSelect

CAL_SelectExtra

CAL_SelectSpecial

CAL_ShowExtra

CAL_ShowFocus

CAL_ShowGrid

CAL_ShowSpecial

CALN_DateChanged

Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use changes the selected date.

CALN_DateFinished

Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use leaves the control.

CALN_ErrSpace

Not used.

CALN_Scroll

Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use scrolls the calendar to a different month.

CAPTION_ErrorHandler

Not used.

COLOR_CAL_BackExtra

Indicates the background color of the days in the adjacent months in the VisCalendar control.

COLOR_CAL_BackLabel

Indicates the background color of the month name in the VisCalendar control.

COLOR_CAL_ForeDays

Indicates the text color of the days in the VisCalendar control.

COLOR_CAL_ForeExtra

Indicates the text color of the days in the adjacent months in the VisCalendar control.

COLOR_CAL_ForeMonth

Indicates the text color of the month name in the VisCalendar control.

COLOR_PAL_BackColor

COLOR_PAL_BackMenu

DAY_Friday

DAY_Monday

DAY_Saturday

DAY_Sunday

DAY_Thursday

DAY_Tuesday

DAY_Unset

DAY_Wednesday

DBF_IncrementalTime

DBF_MessageBox

DBF_RealTime

DESKTOP_MyComputer

Value associated with the computer node in the VisDesktopListBox control.

DESKTOP_NetworkNeighborhood

Value associated with the network neighborhood node in the VisDesktopListBox control.

DESKTOP_Root

Value associated with the desktop node in the VisDesktopListBox control.

DOS_BreakFlag

DOS_ErrorMode

DOS_VerifyFlag

DRIVE_CDROM

CD drive

DRIVE_Fixed

fixed drive

DRIVE_Floppy

floppy drive

DRIVE_Network

network drive

DRIVE_RAM

RAM drive

DROP_Child

Drop Flags

DROP_Sibling

DT_Handle

Indicates a SalWindowHandle data type.

EM_SetReadOnly

Edit control messages

FA_Volume

File attribute flags

FILETYPE_Document

FILETYPE_Other

FILETYPE_Program

File types

FILETYPE_System

FONTTYPE_Device

FONTTYPE_Raster

FONTTYPE_TrueType

hPicNull

Null picture handle.

ITEM_CanCollapse

ITEM_CanDemote

ITEM_CanExpand

ITEM_CanMoveDown

ITEM_CanMoveUp

ITEM_CanPromote

ITEM_IsDeleted

ITEM_IsDisabled

ITEM_IsExpanded

ITEM_IsFocus

ITEM_IsFrame

ITEM_IsHidden

ITEM_IsParent

ITEM_IsSelected

KDS_Alt

KDS_AltCtrl

KDS_AltShift

KDS_Ctrl

KDS_None

KDS_Shift

KDS_ShiftAltCtrl

KDS_ShiftCtrl

KS_Down

KS_LockOn

LBS_DisableNoScroll

LBS_DragSelect

LBS_Editable

LBS_Explorer

LBS_ExtendedCombo

LBS_FmtLowercase

LBS_FmtMixedcase

LBS_FmtUppercase

LBS_KillFocusFrameSelect

LBS_KillFocusNoSelect

LBS_NoAutoResize

LBS_SetWidthEachInsert

LBS_ShowHorzScrollBar

LBS_ShowNoEditSelect

LBS_ShowNoEditText

LBS_ShowNoSelect

LBS_ShowNoTree

LBS_ShowPicCenter

LBS_ShowSelectBkgd

LBS_ShowSelectColor

LBS_ShowSelectText

LBS_ShowSelectTextPicture

LBS_VisExtensions

LVA_AligLeft

LVA_AligTop

LVA_Default

LVA_SnapToGrid

LVCF_Fmt

LVCF_Text

LVCF_Width

LVCFMT_Center

LVCFMT_JustifyMask

LVCFMT_Left

LVCFMT_Right

LVFI_NearestXY

LVFI_Partial

LVFI_String

LVFI_Wrap

LVHT_Above

LVHT_Below

LVHT_Nowhere

LVHT_OnItem

LVHT_OnItemIcon

LVHT_OnItemLabel

LVHT_OnItemStateIcon

LVHT_ToLeft

LVHT_ToRight

LVIF_Image

LVIF_Param

LVIF_State

LVIF_Text

LVIR_Bounds

LVIR_Icon

LVIR_Label

LVIR_SelectBounds

LVIS_Cut

LVIS_DropHilited

LVIS_Focused

LVIS_Selected

LVIS_StateImageMask

LVN_BeginDrag

LVN_BeginRDrag

LVN_ColumnClick

LVN_DeleteAllItems

LVN_DeleteItem

LVN_First

LVN_InsertItem

LVN_ItemChanged

LVN_ItemChanging

LVNI_Above

LVNI_All

LVNI_Below

LVNI_Cut

LVNI_DropHilited

LVNI_Focused

LVNI_Selected

LVNI_ToLeft

LVNI_ToRight

LVS_AlignLeft

LVS_AlignMask

LVS_AlignTop

LVS_AutoArrange

LVS_EditLabels

LVS_Icon

LVS_List

LVS_NoColumnHeader

LVS_NoLabelWrap

LVS_NoScroll

LVS_NoSortHeader

LVS_Report

LVS_ShowSelAlways

LVS_SingleSel

LVS_SmallIcon

LVS_TypeMask

LVS_TypeStyleMask

LVSORT_Ascending

sort ascending

LVSORT_Descending

sort descending

MBF_IconAsterisk

MBF_IconError

MBF_IconExclamation

MBF_IconHand

MBF_IconInformation

MBF_IconQuestion

MBF_IconStop

MBF_IconWarning

MF_Check

checked

MF_Disable

disabled

MF_Separator

menu separator

NM_Click

NM_DoubleClick

NM_First

NM_KillFocus

NM_OutOfMemory

NM_Return

NM_RightClick

NM_RightDoubleClick

NM_SetFocus

ORIENT_SPLIT_Horizontal

ORIENT_SPLIT_Unset

ORIENT_SPLIT_Vertical

PAL_EnableMRUColors

PAL_NoHideSelects

PALETTE_Main

PALETTE_MRU

PALN_Changed

PALN_ErrSpace

PALN_Finished

PALN_Menu

PIC_LoadFile

PIC_LoadLargeIcon

PIC_LoadResource

PIC_LoadSmallIcon

PIC_LoadSWinRes

PIC_LoadSWinStr

PicDesktop

Image used to represent the desktop node in the VisDesktopListBox control.

PicDriveCD

CD drive

PicDriveFixed

fixed drive

PicDriveFloppy

floppy drive

PicDriveNetwork

network drive

PicDriveRemovable

removable drive

PicFolderClosed

Image used to represent a closed node in the VisOutlineListBox control.

PicFolderOpen

Image used to represent an open node in the VisOutlineListBox control.

PicMyComputer

Image used to represent the computer node in the VisDesktopListBox control.

PicNetworkNeighborhood

Image used to represent the network neighborhood node in the VisDesktopListBox control.

PicTTFont

the image used to populate the fonts

REF_AutoHScroll

REF_AutoVScroll

REF_AutoWordSelection

REF_CFE_AutoColor

REF_CFE_Bold

REF_CFE_Italic

REF_CFE_Protected

REF_CFE_Strikeout

REF_CFE_Underline

REF_FT_MatchCase

matches case

REF_FT_WholeWord

matches whole word

REF_NoHideSel

REF_PFA_Center

REF_PFA_Left

REF_PFA_Right

REF_PFN_Bullet

Paragraph Format Numbering Flags (duplicates of PFN_ constants from Microsoft's RICHEDIT.H)

REF_ReadOnly

REF_SaveSelection

REF_SEL_Empty

REF_SEL_MultiChar

REF_SEL_MultiObject

REF_SEL_Object

REF_SEL_Text

REF_Vertical

REGION_Main

REGION_Menu

REGION_MRU

REN_Change

REN_ErrSpace

REN_HScroll

REN_MaxText

REN_Protected

REN_RequestResize

REN_SelChange

REN_Update

REN_VScroll

ROW_UserFlag1

ROW_UserFlag2

ROW_UserFlag3

ROW_UserFlag4

ROW_UserFlag5

SEEK_Begin

SEEK_Current

SEEK_End

SEQ_First

SEQ_Fourth

SEQ_Last

SEQ_Second

SEQ_Third

SEQ_Unset

SHOW_AllLevels

Show All Levels

SHOW_Hidden

SHOW_Maximized

SHOW_Minimized

SHOW_Normal

SM_DBCSEnabled

SM_Debug

SM_MenuDropAlignment

SM_MousePresent

SM_PenWindows

SM_SwapButton

SM_XBorder

SM_XCursor

SM_XDlgFrame

SM_XDoubleClick

SM_XFrame

SM_XFullScreen

SM_XHScroll

SM_XHThumb

SM_XIcon

SM_XIconSpacing

SM_XMin

SM_XMinTrack

SM_XScreen

SM_XSize

SM_XVScroll

SM_YBorder

SM_YCaption

SM_YCursor

SM_YDlgFrame

SM_YDoubleClick

SM_YFrame

SM_YFullScreen

SM_YHScroll

SM_YIcon

SM_YIconSpacing

SM_YKanjiWindow

SM_YMenu

SM_YMin

SM_YMinTrack

SM_YScreen

SM_YSize

SM_YVScroll

SM_YVThumb

SORT_Ascending

Sort ascending flag for ArraySort.

SORT_Descending

Sort descending flag for ArraySort

SPECIAL_MonthlyDOM

SPECIAL_MonthlyDOW

SPECIAL_OneTime

SPECIAL_Unset

SPECIAL_Weekly

SPECIAL_Yearly

SPECIAL_YearlyDOW

VK_0

VK_1

VK_2

VK_3

VK_4

VK_5

VK_6

VK_7

VK_8

VK_9

VK_A

VK_Add

VK_Alt

VK_B

VK_Backspace

VK_C

VK_Cancel

VK_CapsLock

VK_Clear

VK_Control

VK_D

VK_Decimal

VK_Delete

VK_Divide

VK_Down

VK_E

VK_End

VK_Enter

VK_Escape

VK_Execute

VK_F

VK_F1

VK_F10

VK_F11

VK_F12

VK_F2

VK_F3

VK_F4

VK_F5

VK_F6

VK_F7

VK_F8

VK_F9

VK_G

VK_H

VK_Help

VK_Home

VK_I

VK_Insert

VK_J

VK_K

VK_L

VK_Left

VK_LeftButton

VK_M

VK_MiddleButton

VK_Multiply

VK_N

VK_NumLock

VK_O

VK_P

VK_PageDown

VK_PageUp

VK_Pause

VK_PrintScreen

VK_Q

VK_R

VK_Right

VK_RightButton

VK_S

VK_ScrollLock

VK_Select

VK_Separator

VK_Shift

VK_Space

VK_Subtract

VK_T

VK_Tab

VK_U

VK_Up

VK_V

VK_W

VK_X

VK_Y

VK_Z

VT_DLLName

VT_SWP_NoZOrder

Show Window Flags

VTERR_AccessDenied

VTERR_BadNetName

VTERR_BadNetPath

VTERR_DiskFull

VTERR_DriveNotReady

VTERR_EndOfFile

VTERR_FileNotFound

VTERR_InvalidData

VTERR_InvalidDrive

VTERR_InvalidHandle

VTERR_InvalidParameter

VTERR_LockViolation

VTERR_NetNameDeleted

VTERR_NetworkAccessDenied

VTERR_NetworkBusy

VTERR_NetworkUnreachable

VTERR_NetWriteFault

VTERR_NoMemory

VTERR_NoMoreFiles

VTERR_Ok

VTERR_PathNotFound

VTERR_ReadFault

VTERR_SharingViolation

VTERR_TooManyFiles

VTERR_WriteFault

VTERR_WriteProtected

VTM_Accelerator

VTM_Base

VTM_Char

VTM_Click

VTM_ControlCreate

VTM_Create

VTM_CreateComplete

VTM_Destroy

VTM_Enable

VTM_EraseBkgnd

VTM_KeyDown

VTM_KeyUp

VTM_LeftClick

VTM_LeftDoubleClick

VTM_LVColumnClick

! ***message returning Column header clicked

VTM_MenuSelect

VTM_MiddleClick

VTM_MiddleDoubleClick

VTM_OutlineCornerClick

VTM_Populate

VTM_RightClick

VTM_RightDoubleClick

VTM_Size

VTM_SpinGetValue

VTM_SpinScrollDown

VTM_SpinScrollUp

VTM_SpinSetIncrement

VTM_SpinSetMax

VTM_SpinSetMin

VTM_SpinSetValue

VTPIC_BookClosed

VTPIC_BookOpen

VTPIC_BookShelf2

VTPIC_BookShelf3

VTPIC_CheckBlack

VTPIC_CheckBoxOff

VTPIC_CheckBoxOn

VTPIC_CheckWhite

VTPIC_Desktop

VTPIC_DiamondBlackClosed

VTPIC_DiamondBlackOpen

VTPIC_DiamondWhiteClosed

VTPIC_DiamondWhiteOpen

VTPIC_DriveCDROM

VTPIC_DriveCDROM2

VTPIC_DriveFixed

VTPIC_DriveFloppy

VTPIC_DriveNetwork

VTPIC_DriveNetworkX

VTPIC_DriveRAM

VTPIC_Empty

VTPIC_FileAllOther

VTPIC_FileDocuments

VTPIC_FilePrograms

VTPIC_FileSystem

VTPIC_Folder

VTPIC_Folder2

VTPIC_FolderCur

VTPIC_FolderCurMinus

VTPIC_FolderCurPlus

VTPIC_FolderMinus

VTPIC_FolderOpen

VTPIC_FolderOpen2

VTPIC_FolderPlus

VTPIC_FontPrinter

VTPIC_FontTrueType

VTPIC_MinusDark

VTPIC_MinusLight

VTPIC_MinusWhite

VTPIC_MyComputer

VTPIC_NetworkNeighborhood

VTPIC_PlusDark

VTPIC_PlusLight

VTPIC_PlusWhite

VTPIC_PrevDirectory

VTPIC_RadioOff

VTPIC_RadioOn

WAIT_SysModalOff

WAIT_SysModalOn

WAIT_TempOff

WAIT_TempOn

WF_80x87

WF_CPU286

WF_CPU386

WF_CPU486

WF_DisplayOnly

WF_EnableWhenNotNull

WF_Enhanced

WF_FitPath

WF_NoClear

WF_NoClearEditFlag

WF_Paging

WF_PMode

WF_Required

Window Flags

WF_Standard

WF_WLO

Methods

ArrayAppend(SourceArray, TargetArray, dataType)

Appends one array to the end of another array.

Parameter
Type
Description

SourceArray

TargetArray

dataType

Returns: SalNumber.

ArrayCopy(SourceArray, TargetArray, dataType)

Copies the source array to the target array.

Parameter
Type
Description

SourceArray

TargetArray

dataType

Returns: SalNumber.

ArrayDeleteItem(array, index, dataType)

Deletes an item from an array.

Parameter
Type
Description

dataType

Returns: SalNumber.

ArrayFillDateTime(array, value, count)

Fills a Date/Time array with the specified date/time value.

Parameter
Type
Description

Returns: SalBoolean.

ArrayFillNumber(array, value, count)

Fills a Number array with the specified numeric value.

Parameter
Type
Description

Returns: SalBoolean.

ArrayFillString(array, value, count)

Fills a String array with the specified string value.

Parameter
Type
Description

Returns: SalBoolean.

ArrayFindDateTime(array, searchFor)

Locates a date/time value within an array.

Parameter
Type
Description

Returns: SalNumber.

ArrayFindNumber(array, searchFor)

Locates a numeric value within an array.

Parameter
Type
Description

Returns: SalNumber.

ArrayFindNumber(array, searchFor)

Locates a numeric value within an array.

Parameter
Type
Description

Returns: SalNumber.

ArrayFindString(array, searchFor)

Locates a string value within an array.

Parameter
Type
Description

Returns: SalNumber.

ArrayInsertItem(array, index, dataType)

Inserts an item into an array.

Parameter
Type
Description

dataType

Returns: SalNumber.

ArraySort(array, sortOrder, dataType)

Sorts an array.

Parameter
Type
Description

sortOrder

dataType

Returns: SalNumber.

DebugAssert(expression, DebugString)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

expression

DebugString

Returns: SalBoolean.

DebugBeginTime()

Deprecated: Use System.Diagnostics.Debug Not supported.

Returns: SalBoolean.

DebugEndTime(Context, DebugLevel)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

Context

DebugLevel

Returns: SalBoolean.

DebugGetFlags()

Deprecated: Use System.Diagnostics.Debug Not supported.

Returns: SalNumber.

DebugSetFlags(Flags, Mode)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

Returns: SalNumber.

DebugSetLevel(DebugLevel)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

DebugLevel

Returns: SalBoolean.

DebugSetTime(Context)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

Context

Returns: SalBoolean.

DebugString(DebugString, DebugLevel)

Deprecated: Use System.Diagnostics.Debug Not supported.

Parameter
Type
Description

DebugString

DebugLevel

Returns: SalBoolean.

DosBuildFullName(moduleName, fileName)

Composes a full path by combining the current directory and the specified file name.

Parameter
Type
Description

moduleName

fileName

Returns: SalString.

DosEnumDirInfo(dirSpec, dirs, dateTimes, attributes)

Returns information about the directories selected using the specified wild card.

Parameter
Type
Description

Returns: SalNumber.

DosEnumDirs(dirSpec, dirs)

Enumerates all the directories using the specified wild card.

Parameter
Type
Description

Returns: SalNumber.

DosEnumDrives(drives)

Enumerates all the logical drives.

Parameter
Type
Description

Returns: SalNumber.

DosEnumFileInfo(fileSpec, attribute, files, sizes, dateTimes, attributes)

Returns information for the files selected using the specified wild card.

Parameter
Type
Description

Returns: SalNumber.

DosEnumFiles(fileSpec, attributes, files)

Enumerates all the files using the specified wild card.

Parameter
Type
Description

fileSpec

File name or file pattern of the files to retrieve.

attributes

The attributes of the files to retrieve.

files

Returns the names of the files that match the specified name and attributes.

Returns: SalNumber.

DosEnumNetConnections(devices, netNames)

Enumerates all the network connections.

Parameter
Type
Description

Returns: SalNumber.

DosEnumPath(directories)

Enumerates all the paths in the PATH environment variable.

Parameter
Type
Description

Returns: SalNumber.

DosExist(fileSpec)

Checks if the specified directory exists.

Parameter
Type
Description

fileSpec

The path of the file or director to check.

Returns: SalBoolean.

DosGetCurDir(drive)

Returns the current directory.

Parameter
Type
Description

Returns: SalString.

DosGetDriveSize(drive, totalSpace, freeSpace)

Parameter
Type
Description

totalSpace

freeSpace

Returns: SalNumber.

DosGetDriveType(drive)

Returns the type of the specified drive.

Parameter
Type
Description

drive

The drive letter to check.

Returns: SalNumber.

DosGetEnvString(name)

Gets environment value for the specified name .

Parameter
Type
Description

name

The name of the environment variable to read.

Returns: SalString.

DosGetFlags()

Deprecated: Flags VisDosGetFlags ()

Returns: SalNumber.

DosGetNetName(device)

Retrieves the name of the network resource associated with a local device.

Parameter
Type
Description

device

Returns: SalString.

DosGetVersion()

Returns the OS version.

Returns: SalNumber.

DosGetVolumeLabel(drive)

Returns the volume label of the specified drive.

Parameter
Type
Description

drive

The drive letter for which to read the volume label.

Returns: SalString.

DosIsParent(dirSpec)

Returns TRUE if directory contains subdirectories

Parameter
Type
Description

dirSpec

The name of the directory; or empty for the current directory.

Returns: SalBoolean.

DosMakeAllDir(dir)

Makes directory including all subdirectories.

Parameter
Type
Description

dir

Path name of the directory and subdirectories to create.

Returns: SalNumber.

DosMakePath(drive, dir, baseStr, ext)

Combines drive, dir, base and extension to a file path

Parameter
Type
Description

Returns: SalString.

DosNetConnect(device, netName, password)

Makes a connection to a network resource.

Parameter
Type
Description

device

netName

password

Returns: SalNumber.

DosNetDisconnect(device, force)

Disconnect a connection

Parameter
Type
Description

Returns: SalNumber.

DosSetFlags(Flags, state)

Deprecated: Not supported.

Parameter
Type
Description

Returns: SalNumber.

DosSetVolumeLabel(drive, label)

Sets the label of a file system volume.

Parameter
Type
Description

Returns: SalNumber.

DosSplitPath(fileSpec, drive, dir, baseStr, ext)

Parameter
Type
Description

Returns: SalNumber.

ErrorRecovery(Caption)

Displays an error message and allows user to retry the operation or halt the application.

Parameter
Type
Description

Caption

Returns: SalNumber.

FileAppend(sourceFile, targetFile)

Appends one file to another.

Parameter
Type
Description

sourceFile

targetFile

Returns: SalNumber.

FileClose(file)

Closes a file.

Parameter
Type
Description

Returns: SalNumber.

FileCopy(sourceFile, targetFile)

Copies a file

Parameter
Type
Description

sourceFile

targetFile

Returns: SalNumber.

FileCreateTemp(prefix)

Gets a new temp file name.

Parameter
Type
Description

prefix

Returns: SalString.

FileDelete(fileName)

Deletes a file.

Parameter
Type
Description

fileName

Returns: SalNumber.

FileExpand(sourceFile, targetFile)

Deprecated: Copies a compressed source file to a destination file.

Parameter
Type
Description

sourceFile

targetFile

Returns: SalNumber.

FileFind(fileName)

Searches for a file.

Parameter
Type
Description

fileName

Returns: SalString.

FileGetAttribute(fileName)

Gets the attribute bit values for the specified file.

Parameter
Type
Description

fileName

Returns: SalNumber.

FileGetSize(fileName)

Gets the size of the specified file.

Parameter
Type
Description

fileName

Returns: SalNumber.

FileGetType(fileName)

Gets the type of the specified file.

Parameter
Type
Description

fileName

Returns: SalNumber.

FileOpen(file, fileName, flags)

Parameter
Type
Description

Returns: SalNumber.

FileRead(file, buffer, size)

Parameter
Type
Description

Returns: SalNumber.

FileReadBinary(file, buffer, numBytes)

Parameter
Type
Description

Returns: SalNumber.

FileReadString(file, line)

Parameter
Type
Description

Returns: SalNumber.

FileRename(sourceFile, targetFile)

Renames one or more files. Wild card characters are supported in both the source and target file names. If the source and target directories are different but the file names are the same, the files are moved to the target directory specified.

Parameter
Type
Description

sourceFile

targetFile

Returns: SalNumber.

FileSeek(file, offset, origin)

Positions within a file.

Parameter
Type
Description

Returns: SalNumber.

FileSetAttribute(fileName, attributes, state)

Sets attributes for a file.

Parameter
Type
Description

fileName

attributes

Returns: SalNumber.

FileSetDateTime(fileName, dateTime)

Sets datetime of a file.

Parameter
Type
Description

fileName

dateTime

Returns: SalNumber.

FileTell(file)

Returns current offset in an open file.

Parameter
Type
Description

Returns: SalNumber.

FileWrite(file, buffer, size)

Writes a buffer to a file.

Parameter
Type
Description

Returns: SalNumber.

FileWriteBinary(file, buffer)

Writes the binary buffer to the file.

Parameter
Type
Description

Returns: SalNumber.

FileWriteString(file, line)

Writes the line of text to the file.

Parameter
Type
Description

Returns: SalNumber.

FontEnum(Type, Names, Types)

Enumerates all the installed fonts.

Parameter
Type
Description

Returns: SalNumber.

FontFree(fontHandle)

Release the font handle.

Parameter
Type
Description

fontHandle

Returns: SalBoolean.

FontGet(fontHandle, faceName, pointSize, fontFlags)

Parameter
Type
Description

fontHandle

faceName

pointSize

fontFlags

Returns: SalBoolean.

FontLoad(faceName, pointSize, enhFlags)

Loads the specified font.

Parameter
Type
Description

faceName

pointSize

enhFlags

Returns: SalNumber.

GetCommonDir(ctrl, index)

Retrieves the current directory of a common dialog list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalString.

GetCopyright()

Retrieves a copyright string.

Returns: SalString.

GetKeyState(VirtKey)

Retrieves the state of a specified key.

Parameter
Type
Description

VirtKey

Returns: SalNumber.

GetSystemMetrics(index)

Retrieves various system metrics (widths and heights of display elements) and system configuration settings.

Parameter
Type
Description

Returns: SalNumber.

GetVersion()

Gets version information.

Returns: SalString.

GetWiFlags()

Deprecated: This function is not implemented in CTD too, it always returns 0. It can be deleted. Not supported.

Returns: SalNumber.

GetWinVersion()

Gets windows version information.

Returns: SalNumber.

ListAddColor(ctrl, text, color)

Adds an item to the list and displays it in the specified color.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListAddColorValue(ctrl, text, color, value)

Adds an item to the list, displays it in the specified color and associates the specified value with the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListAddFont(ctrl, text, fontHandle)

Adds an item to the list control and displays it in the specified font.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalNumber.

ListAddFontValue(ctrl, text, fontHandle, value)

Adds an item to the list control, displays it in the specified font and associates the specified value to the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalNumber.

ListAddPicture(ctrl, text, picNormal, picSelected)

Adds an item to the list control and specified an image for the normal and selected state.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalNumber.

ListAddPictureValue(ctrl, text, picNormal, picSelected, value)

Adds an item to the list control and specified an image for the normal and selected state, and a value to associate with the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalNumber.

ListAddValue(ctrl, text, value)

Adds an item to a sorted list box or combo box and associates the specified value with the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListArrayPopulate(ctrl, items)

Populates a list box from a string array.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListArrayPopulateValue(ctrl, items, values)

Populates a list box from a string and a value array.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListClearSelection(ctrl)

Unselects all selected items in a list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListCollapse(ctrl, index)

Collapses all descendant items.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListDeleteChild(ctrl, index)

Deletes the child item from the tree control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListDeleteDescendents(ctrl, index)

Deletes all descendants (children, grandchildren, and so on) of the specified child.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListDeleteSelected(ctrl)

Deletes all selected items from a list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListDemote(ctrl, index, picNormal, picSelect)

Moves an item and all descendants of the item right in the outline.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelect

Returns: SalBoolean.

ListDisableItem(ctrl, index, color)

Disables the specified item and sets the specified color.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListDragDrop(ctrl, sourceIndex, targetCtrl, targetIndex, dropFlags)

Implements drag and drop

Parameter
Type
Description

ctrl

Target control on which to execute the call.

sourceIndex

targetCtrl

targetIndex

dropFlags

Returns: SalBoolean.

ListEnableItem(ctrl, index, color)

Enables the specified item and sets the specified color.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListEnumChildren(item, items)

Enumerates child item handles for a specified item.

Parameter
Type
Description

Returns: SalNumber.

ListEnumDescendents(item, items)

Enumerates descendant (children, grandchildren, and so on) item handles for a specified item.

Parameter
Type
Description

Returns: SalNumber.

ListExpand(ctrl, index)

Expands an outline one level at the index specified.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListExpandDescendents(ctrl, index)

Displays all descendants of an item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListFindItemValue(item, value)

Finds list item by value

Parameter
Type
Description

Returns: SalNumber.

ListFindString(ctrl, startIndex, text)

Finds the first string that matches the specified text in a list box or combo box. The search is not case sensitive but requires an exact match of all characters.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

startIndex

Returns: SalNumber.

ListFindValue(ctrl, startIndex, value)

Finds the first value that matches the specified value in a list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

startIndex

Returns: SalNumber.

ListFreeChild(item)

Frees memory for the item specified and for all its descendants.

Parameter
Type
Description

Returns: SalBoolean.

ListFreeDescendents(item)

Frees memory for all descendants of the item specified.

Parameter
Type
Description

Returns: SalBoolean.

ListGetColor(ctrl, index)

Returns the current color of the list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetDropdownState(ctrl)

Determines whether the list box portion of a combo box is visible.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListGetFlags(ctrl, index)

Returns the ITEM_* flags for the specified list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetFocusIndex(ctrl)

Gets the index of the item which has the focus rectangle or the last item to receive the focus frame in a multiple-selection list box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetFont(ctrl, index)

Returns the current font of the list control item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetIndexFromPoint(ctrl, X, Y)

Gets list index from a point

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetItemColor(item)

Retrieves the color associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

ListGetItemData(item, text, value, itemFlags)

Parameter
Type
Description

Returns: SalBoolean.

ListGetItemFlags(item)

Gets item flags

Parameter
Type
Description

Returns: SalNumber.

ListGetItemFont(item)

Retrieves the font associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

ListGetItemHandle(ctrl, index)

Retrieves the item handle based on an index specified.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetItemIndex(item)

Returns the index of the specified outline item.

Parameter
Type
Description

Returns: SalNumber.

ListGetItemPicture(item, picNormal, picSelect)

Parameter
Type
Description

picNormal

picSelect

Returns: SalBoolean.

ListGetItemText(item)

Returns the text for the outline item.

Parameter
Type
Description

Returns: SalString.

ListGetItemValue(item)

Returns the value saved with the outline item.

Parameter
Type
Description

Returns: SalNumber.

ListGetLevel(item)

Returns the level number for an outline item.

Parameter
Type
Description

Returns: SalNumber.

ListGetNextSibling(item)

Retrieves the item handle for the next sibling of the specified item.

Parameter
Type
Description

Returns: SalNumber.

ListGetParent(item)

Retrieves the item handle for the parent of the specified item.

Parameter
Type
Description

Returns: SalNumber.

ListGetPicture(ctrl, index, picNormal, picSelected)

Parameter
Type
Description

picNormal

picSelected

Returns: SalNumber.

ListGetPrevSibling(item)

Retrieves the item handle for the previous sibling of the specified item.

Parameter
Type
Description

Returns: SalNumber.

ListGetRoot(ctrl)

Returns the handle for the root node.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetStyle(ctrl)

Returns the LBS_* style for the specified control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetText(ctrl, index)

Returns the text of the list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalString.

ListGetTextRectangle(ctrl, index, top, left, bottom, right)

Parameter
Type
Description

Returns: SalBoolean.

ListGetValue(ctrl, index)

Returns the value associated to the list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListGetVisibleRange(ctrl, top, bottom)

Parameter
Type
Description

Returns: SalNumber.

ListInsertColor(ctrl, index, text, color)

Inserts an item to the list control at the specified position and displays it in the specified color.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListInsertColorValue(ctrl, index, text, color, value)

Inserts an item to the list control at the specified position, displays it in the specified color and associates the specified value to the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListInsertFont(ctrl, index, text, fontHandle)

Adds an item to a list control at the specified index and displays it in the specified font.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalNumber.

ListInsertFontValue(ctrl, index, text, fontHandle, value)

Adds an item to the list control, displays it in the specified font, and associates the specified value with the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalNumber.

ListInsertPicture(ctrl, index, text, picNormal, picSelected)

Inserts an item at the specified position and specifies an image for the normal and selected state.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalNumber.

ListInsertPictureValue(ctrl, index, text, picNormal, picSelected, value)

Inserts an item at the specified position and specifies an image for the normal and selected state, and associates a value to the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalNumber.

ListInsertValue(ctrl, index, text, value)

Inserts an item into an unsorted list box or combo box and associates the specified value with the item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListIsMultiSelect(ctrl)

Returns true if the list box is multi select.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListLoadChild(ctrl, itemParent, picNormal, picSelect, text, value, itemFlags)

Inserts an item as the last child of the specified parent.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

itemParent

picNormal

picSelect

itemFlags

Returns: SalNumber.

ListLoadChildren(ctrl, itemParent, picNormal, picSelect, texts, values, itemFlags)

Loads with arrays from children

Parameter
Type
Description

ctrl

Target control on which to execute the call.

itemParent

picNormal

picSelect

Returns: SalNumber.

ListLoadOutline(ctrl, blob)

Load outline from a blob

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListLoadOutlineFile(ctrl, fileName, picParentNormal, picParentSelect, picChildNormal, picChildSelect)

Load outline from a file

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fileName

picParentNormal

picParentSelect

picChildNormal

picChildSelect

Returns: SalNumber.

ListLoadSibling(ctrl, itemBefore, picNormal, picSelect, text, value, itemFlags)

Load sibling

Parameter
Type
Description

ctrl

Target control on which to execute the call.

itemBefore

picNormal

picSelect

itemFlags

Returns: SalNumber.

ListMoveDown(ctrl, index)

Move item down

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListMoveUp(ctrl, index)

Move item up

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListPromote(ctrl, index, picNormal, picSelect)

Promote item

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelect

Returns: SalBoolean.

ListSaveOutline(ctrl, blob)

Parameter
Type
Description

Returns: SalNumber.

ListScroll(ctrl, index)

Scrolls an item into view.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListSetColor(ctrl, index, color)

Sets the color of a list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListSetDropdownState(ctrl, state)

Shows or hides the list box portion of a combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListSetFlags(ctrl, index, itemFlags, state)

Sets the ITEM_* flags for the specified list item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

itemFlags

Returns: SalNumber.

ListSetFocusIndex(ctrl, index)

Sets the focus rectangle to the item at the specified index in a multiple-selection list box. If the item is not visible, it is scrolled into view.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListSetFont(ctrl, index, fontHandle)

Sets the font of the list control item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalBoolean.

ListSetIndent(ctrl, indent)

Set list indentation

Parameter
Type
Description

ctrl

Target control on which to execute the call.

indent

Returns: SalBoolean.

ListSetItemColor(item, color)

Sets the color of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

ListSetItemData(ctrl, item, text, value, itemFlags)

Updates the specified item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

itemFlags

Returns: SalNumber.

ListSetItemFlags(item, itemFlags, state)

Sets item flags

Parameter
Type
Description

Returns: SalBoolean.

ListSetItemFont(item, fontHandle)

Sets the font of the outline item.

Parameter
Type
Description

fontHandle

Returns: SalBoolean.

ListSetItemPicture(item, picNormal, picSelect)

Sets the picture of a list item

Parameter
Type
Description

picNormal

picSelect

Returns: SalBoolean.

ListSetItemText(item, text)

Sets the text of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

ListSetItemValue(item, value)

Sets the value associated to the outline item.

Parameter
Type
Description

Returns: SalBoolean.

ListSetOutlineRedraw(ctrl, redraw)

Sets outline redraw

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

ListSetPicture(ctrl, index, picNormal, picSelected)

Changes the normal and selected images for the specified item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalBoolean.

ListSetScrollWidth(ctrl, index)

Sets the width by which a list box can be scrolled horizontally.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListSetStyle(ctrl, style, lParam)

Sets the LBS_* style of the specified control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

lParam

Returns: SalBoolean.

ListSetText(ctrl, index, text)

Changes the text of the list item at the specified index.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListSetValue(ctrl, index, value)

Changes the value of the list item at the specified index.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

ListShowOutline(ctrl, level)

Expands list items up to the specified level.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Checks the menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Removes the menu at the requested position.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Disables the menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Enables the menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Returns the number of items in the specified menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

Returns the handle of the main menu of the specified form.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

Retrieves the menu handle of a pop-up menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

Deprecated: Not supported.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

Retrieves the text of a menu item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalString.

Inserts a menu item into a menu.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

Inserts a menu item into a menu and displays it in the specified font.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalNumber.

Inserts a menu item into a menu and displays the specified picture with it.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalNumber.

Returns true if the menu is checked.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Returns true if the menu is enabled.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Changes the font of a menu item created using the PPJ.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontHandle

Returns: SalBoolean.

Displays a picture in a menu item created using the PPJ runtime.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

picNormal

picSelected

Returns: SalBoolean.

Changes the text of a menu item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

Unchecks a menu item.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalBoolean.

MessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons)

Displays a message box with user defined buttons.

Parameter
Type
Description

sMsgText

Text to display in the MessageBox/

sCaption

Title of the MessageBox.

hPicIcon

Handle of the icon to display in the MessageBox.

hBtnHandles

List of MessageBox buttons created using MessageLoadButton.

nNumButtons

Number of MessageBox buttons in hBtnHandles .

Returns: SalNumber.

MessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons, nDefButtonIndex)

Displays a message box with user defined buttons.

Parameter
Type
Description

sMsgText

Text to display in the MessageBox/

sCaption

Title of the MessageBox.

hPicIcon

Handle of the icon to display in the MessageBox.

hBtnHandles

List of MessageBox buttons created using MessageLoadButton.

nNumButtons

Number of MessageBox buttons in hBtnHandles .

nDefButtonIndex

Index of the default button in hBtnHandles .

Returns: SalNumber.

MessageFreeButton(button)

Frees the previously created MessageBox button.

Parameter
Type
Description

button

Returns: SalBoolean.

MessageLoadButton(label, id)

Creates a button to be used in the MessageBox.

Parameter
Type
Description

Returns: SalNumber.

MessageSetBkgdColor(color)

Sets the background color for the customized message box.

Parameter
Type
Description

Returns: SalBoolean.

NumberBitClear(value, bitMask)

Parameter
Type
Description

Returns: SalNumber.

NumberBitSet(value, bitMask)

Parameter
Type
Description

Returns: SalNumber.

NumberChoose(expression, trueValue, falseValue)

Evaluates expression. If the expression evaluates to TRUE, the function returns the value stored in TrueValue if the expression evaluates to FALSE, the function returns the value stored in FalseValue. The expression may be a constant, an expression, or a variable.

Parameter
Type
Description

expression

trueValue

falseValue

Returns: SalNumber.

NumberHighByte(num)

Returns the HighByte of a number

Parameter
Type
Description

Returns: SalNumber.

NumberLowByte(num)

Returns the LowByte of a number

Parameter
Type
Description

Returns: SalNumber.

NumberMakeLong(lowWord, highWord)

Combines a LowWord and a HighWord to a Long

Parameter
Type
Description

lowWord

highWord

Returns: SalNumber.

PicFree(Pic)

Removes a picture and frees it's memory.

Parameter
Type
Description

Returns: SalNumber.

PicLoad(flags, resource, imageName)

Loads a picture into memory from a resource DLL/EXE, image file (.BMP or .ICO), SalResource or string.

Parameter
Type
Description

resource

imageName

Returns: SalNumber.

PopulateCommonDir(ctrl, directory)

Adds all directories to a list box or combo box.

Parameter
Type
Description

ctrl

A control implementing the ISalListControl interface.

directory

Path to the root directory.

Returns: SalNumber. Number of items added to the ctrl .

PopulateDirTree(ctrl, directory)

Populates the tree control with the specified directories.

Parameter
Type
Description

ctrl

A control that inherits the VisListBoxExtension class.

directory

Path to the root directory.

Returns: SalNumber. Number of items added to the ctrl .

PopulateDrives(ctrl)

Adds all available drives to a list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalNumber.

PopulateFontNames(ctrl, fontType)

Populates the control with the names of all the fonts.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fontType

Not used

Returns: SalNumber.

ProfileDelete(fileName, section, entry)

Deletes an entire section or a specific key from the specified .ini file.

Parameter
Type
Description

fileName

section

Returns: SalBoolean.

ProfileEnumStrings(fileName, section, strings)

Retrieves all the keys for the specified section of an initialization file.

Parameter
Type
Description

Returns: SalNumber.

SendMsgString(hWnd, message, wParam, lParam)

Sends a message and passes a string in the lParam.

Parameter
Type
Description

Returns: SalNumber.

SetCommonDir(ctrl, index)

Changes the current directory of a common dialog list box or combo box.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalString.

StrChoose(expression, trueValue, falseValue)

sReturn VisStrChoose( expression, TrueValue, FalseValue )

Parameter
Type
Description

expression

trueValue

falseValue

Returns: SalString.

StrExpand(template, array)

Replaces the template placeholders with the values in the specified array .

Parameter
Type
Description

template

Returns: SalString.

StrFind(table, key)

VisStrFind looks up a key in the string table identified by Handle and returns the value

Parameter
Type
Description

table

A handle to the string table (returned by VisStrLoadTable()

key

The key to look up in the string table

Returns: SalString. Returns the value or an empty string if key was not found

StrFreeTable(table)

Frees string table

Parameter
Type
Description

Returns: SalBoolean.

StrLeftTrim(source)

left trims a string

Parameter
Type
Description

source

Returns: SalString.

StrLoadTable(fileName)

VisStrLoadTable loads the lines from a text file and returns a handle to it. Once a table is loaded, VisStrFindTable() can be used to access the values via key. The text file must contain lines following the syntax {key}value Example: {Error.User}User unknown {Error.Password}Incorrect password {Version}Version 1.4.7

Parameter
Type
Description

fileName

The name of the text file to be loaded

Returns: SalNumber. Returns a handle to the string table for later use with VisStrFind and VisStrFreeTable

StrPad(source, size)

Pads a string

Parameter
Type
Description

Returns: SalString.

StrProper(source)

Makes a proper string

Parameter
Type
Description

source

Returns: SalString.

StrRightTrim(source)

Right trims a string

Parameter
Type
Description

source

Returns: SalString.

Scans for a string (reverse)

Parameter
Type
Description

source

position

search

Returns: SalNumber.

StrSubstitute(source, search, replace)

Substitutes Search with Replace in string

Parameter
Type
Description

source

search

replace

Returns: SalString.

StrTrim(Source)

Trim a string

Parameter
Type
Description

Source

Returns: SalString.

TblAllRows(table, flagsOn, flagsOff)

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

Parameter
Type
Description

table

flagsOn

flagsOff

Returns: SalBoolean.

TblAutoSizeColumn(table, column)

Performs a best fit on the display contents of a specific column.

Parameter
Type
Description

table

column

Returns: SalBoolean.

TblClearColumnSelection(table)

Clears column selection

Parameter
Type
Description

table

Returns: SalBoolean.

TblFindDateTime(table, row, column, date)

Finds a DateTime in the table control.

Parameter
Type
Description

Returns: SalNumber.

TblFindNumber(table, row, column, number)

Finds a number in the table control.

Parameter
Type
Description

Returns: SalNumber.

TblFindString(table, row, column, pattern)

Finds a string in the table control.

Parameter
Type
Description

Returns: SalNumber.

TblGetCell(table, row, column)

Retrieves the contents of a cell in a table window.

Parameter
Type
Description

Returns: SalString.

TblGetColumnTitle(column)

Retrieves the contents of a column heading.

Parameter
Type
Description

column

Returns: SalString.

TblSetRowColor(table, row, color)

Sets the text color for an entire row of a table window.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowPicture(table, rowFlags, picture)

Sets the picture for a bit flag of a table window.

Parameter
Type
Description

table

rowFlags

picture

Returns: SalBoolean.

WaitCursor(Flags)

Turns hourglass cursor on or off.

Parameter
Type
Description

Returns: SalNumber.

WinClearAllEditFlags(parent)

Clears the field edit flags for each data field or multi-line text field of a parent window.

Parameter
Type
Description

parent

Returns: SalNumber.

WinClearAllFields(parent)

Clears all fields

Parameter
Type
Description

parent

Returns: SalNumber.

WinEnumProps(hWnd, propNames, propValues)

Enumerates windows properties

Parameter
Type
Description

Returns: SalNumber.

WinFreeAccelerator(accelerator)

Removes the accelerator.

Parameter
Type
Description

accelerator

Returns: SalBoolean.

WinGetFlags(hWnd)

Gets windows flags

Parameter
Type
Description

Returns: SalNumber.

WinGetHandle(ctrl, text, type)

Obtains the control of the requested type and text.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalWindowHandle.

WinGetProp(hWnd, propName)

Gets a windows property by name

Parameter
Type
Description

Returns: SalNumber.

WinGetStyle(hWnd)

Retrieves the Windows style bits for a specified window.

Parameter
Type
Description

Returns: SalNumber.

WinGetText(ctrl)

Obtains the text of a window.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalString.

WinIsChild(parent, Child)

Tests whether a specified window is a child or direct descendant of a parent window.

Parameter
Type
Description

Returns: SalBoolean.

WinIsMaximized(hWnd)

Determines whether a window is maximized.

Parameter
Type
Description

Returns: SalBoolean.

WinIsMinimized(hWnd)

Determines whether the specified window is minimized (iconic).

Parameter
Type
Description

Returns: SalBoolean.

WinIsRequiredFieldNull(parent)

Returns the first required field that is empty.

Parameter
Type
Description

parent

Returns: SalWindowHandle.

WinIsRestored(hWnd)

Determines whether the specified window is in the normal state.

Parameter
Type
Description

Returns: SalBoolean.

WinIsWindow(hWnd)

Determines whether the specified window handle identifies an existing window.

Parameter
Type
Description

Returns: SalBoolean.

WinLoadAccelerator(target, message, keyState, keyCode, id)

Sets an accelerator keystroke for a window.

Parameter
Type
Description

target

message

keyState

keyCode

Returns: SalNumber.

WinMove(hWnd, left, top, width, height)

Moves and resizes a window, based on pixel coordinates.

Parameter
Type
Description

Returns: SalBoolean.

WinRemoveProp(hWnd, propName)

Removes windows property

Parameter
Type
Description

Returns: SalBoolean.

WinSetFlags(hWnd, winFlags, state)

Set windows flags

Parameter
Type
Description

Returns: SalBoolean.

WinSetMeter(ctrl, percent)

Sets the position of the meter.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

percent

Returns: SalNumber.

WinSetProp(hWnd, propName, propValue)

Set windows property

Parameter
Type
Description

Returns: SalBoolean.

WinSetStyle(hWnd, style, state)

Adds/Removes a window style to a window.

Parameter
Type
Description

Returns: SalBoolean.

WinSetTabOrder(ctrl, ctrlAfter)

Changes the tab order of a control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

ctrlAfter

Returns: SalBoolean.

WinShow(ctrl, showCmd)

Show window

Parameter
Type
Description

ctrl

Target control on which to execute the call.

showCmd

Returns: SalBoolean.

Last updated