Skip to main content

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

NameTypeDescription
ACTION_AbortInt32abort
ACTION_RetryInt32retry
CAL_AlternateButtonsInt32Not used.
CAL_EnableButtonsInt32Not used.
CAL_EnableKeyboardInt32Not used.
CAL_EtchedLookInt32
CAL_MultiSelectInt32
CAL_SelectExtraInt32
CAL_SelectSpecialInt32
CAL_ShowExtraInt32
CAL_ShowFocusInt32
CAL_ShowGridInt32
CAL_ShowSpecialInt32
CALN_DateChangedInt32Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use changes the selected date.
CALN_DateFinishedInt32Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use leaves the control.
CALN_ErrSpaceInt32Not used.
CALN_ScrollInt32Fired by VisCalendar as the wParam value with the SAM_CustControlCmd message when the use scrolls the calendar to a different month.
CAPTION_ErrorHandlerStringNot used.
COLOR_CAL_BackExtraInt32Indicates the background color of the days in the adjacent months in the VisCalendar control.
COLOR_CAL_BackLabelInt32Indicates the background color of the month name in the VisCalendar control.
COLOR_CAL_ForeDaysInt32Indicates the text color of the days in the VisCalendar control.
COLOR_CAL_ForeExtraInt32Indicates the text color of the days in the adjacent months in the VisCalendar control.
COLOR_CAL_ForeMonthInt32Indicates the text color of the month name in the VisCalendar control.
COLOR_PAL_BackColorInt32
COLOR_PAL_BackMenuInt32
DAY_FridayInt32
DAY_MondayInt32
DAY_SaturdayInt32
DAY_SundayInt32
DAY_ThursdayInt32
DAY_TuesdayInt32
DAY_UnsetInt32
DAY_WednesdayInt32
DBF_IncrementalTimeInt32
DBF_MessageBoxInt32
DBF_RealTimeInt32
DESKTOP_MyComputerInt32Value associated with the computer node in the VisDesktopListBox control.
DESKTOP_NetworkNeighborhoodInt32Value associated with the network neighborhood node in the VisDesktopListBox control.
DESKTOP_RootInt32Value associated with the desktop node in the VisDesktopListBox control.
DOS_BreakFlagInt32
DOS_ErrorModeInt32
DOS_VerifyFlagInt32
DRIVE_CDROMInt32CD drive
DRIVE_FixedInt32fixed drive
DRIVE_FloppyInt32floppy drive
DRIVE_NetworkInt32network drive
DRIVE_RAMInt32RAM drive
DROP_ChildInt32Drop Flags
DROP_SiblingInt32
DT_HandleInt32Indicates a SalWindowHandle data type.
EM_SetReadOnlyInt32Edit control messages
FA_VolumeInt32File attribute flags
FILETYPE_DocumentInt32
FILETYPE_OtherInt32
FILETYPE_ProgramInt32File types
FILETYPE_SystemInt32
FONTTYPE_DeviceInt32
FONTTYPE_RasterInt32
FONTTYPE_TrueTypeInt32
hPicNullInt32Null picture handle.
ITEM_CanCollapseUInt32
ITEM_CanDemoteUInt32
ITEM_CanExpandUInt32
ITEM_CanMoveDownUInt32
ITEM_CanMoveUpUInt32
ITEM_CanPromoteUInt32
ITEM_IsDeletedUInt32
ITEM_IsDisabledUInt32
ITEM_IsExpandedUInt32
ITEM_IsFocusUInt32
ITEM_IsFrameUInt32
ITEM_IsHiddenUInt32
ITEM_IsParentUInt32
ITEM_IsSelectedUInt32
KDS_AltInt32
KDS_AltCtrlInt32
KDS_AltShiftInt32
KDS_CtrlInt32
KDS_NoneInt32
KDS_ShiftInt32
KDS_ShiftAltCtrlInt32
KDS_ShiftCtrlInt32
KS_DownInt32
KS_LockOnInt32
LBS_DisableNoScrollInt32
LBS_DragSelectInt32
LBS_EditableInt32
LBS_ExplorerInt32
LBS_ExtendedComboInt32
LBS_FmtLowercaseInt32
LBS_FmtMixedcaseInt32
LBS_FmtUppercaseInt32
LBS_KillFocusFrameSelectInt32
LBS_KillFocusNoSelectInt32
LBS_NoAutoResizeInt32
LBS_SetWidthEachInsertInt32
LBS_ShowHorzScrollBarInt32
LBS_ShowNoEditSelectInt32
LBS_ShowNoEditTextInt32
LBS_ShowNoSelectInt32
LBS_ShowNoTreeInt32
LBS_ShowPicCenterInt32
LBS_ShowSelectBkgdInt32
LBS_ShowSelectColorInt32
LBS_ShowSelectTextInt32
LBS_ShowSelectTextPictureInt32
LBS_VisExtensionsInt32
LVA_AligLeftInt32
LVA_AligTopInt32
LVA_DefaultInt32
LVA_SnapToGridInt32
LVCF_FmtInt32
LVCF_TextInt32
LVCF_WidthInt32
LVCFMT_CenterInt32
LVCFMT_JustifyMaskInt32
LVCFMT_LeftInt32
LVCFMT_RightInt32
LVFI_NearestXYInt32
LVFI_PartialInt32
LVFI_StringInt32
LVFI_WrapInt32
LVHT_AboveInt32
LVHT_BelowInt32
LVHT_NowhereInt32
LVHT_OnItemInt32
LVHT_OnItemIconInt32
LVHT_OnItemLabelInt32
LVHT_OnItemStateIconInt32
LVHT_ToLeftInt32
LVHT_ToRightInt32
LVIF_ImageInt32
LVIF_ParamInt32
LVIF_StateInt32
LVIF_TextInt32
LVIR_BoundsInt32
LVIR_IconInt32
LVIR_LabelInt32
LVIR_SelectBoundsInt32
LVIS_CutInt32
LVIS_DropHilitedInt32
LVIS_FocusedInt32
LVIS_SelectedInt32
LVIS_StateImageMaskInt32
LVN_BeginDragInt32
LVN_BeginRDragInt32
LVN_ColumnClickInt32
LVN_DeleteAllItemsInt32
LVN_DeleteItemInt32
LVN_FirstInt32
LVN_InsertItemInt32
LVN_ItemChangedInt32
LVN_ItemChangingInt32
LVNI_AboveInt32
LVNI_AllInt32
LVNI_BelowInt32
LVNI_CutInt32
LVNI_DropHilitedInt32
LVNI_FocusedInt32
LVNI_SelectedInt32
LVNI_ToLeftInt32
LVNI_ToRightInt32
LVS_AlignLeftInt32
LVS_AlignMaskInt32
LVS_AlignTopInt32
LVS_AutoArrangeInt32
LVS_EditLabelsInt32
LVS_IconInt32
LVS_ListInt32
LVS_NoColumnHeaderInt32
LVS_NoLabelWrapInt32
LVS_NoScrollInt32
LVS_NoSortHeaderInt32
LVS_ReportInt32
LVS_ShowSelAlwaysInt32
LVS_SingleSelInt32
LVS_SmallIconInt32
LVS_TypeMaskInt32
LVS_TypeStyleMaskInt32
LVSORT_AscendingInt32sort ascending
LVSORT_DescendingInt32sort descending
MBF_IconAsteriskInt32
MBF_IconErrorInt32
MBF_IconExclamationInt32
MBF_IconHandInt32
MBF_IconInformationInt32
MBF_IconQuestionInt32
MBF_IconStopInt32
MBF_IconWarningInt32
MF_CheckInt32checked
MF_DisableInt32disabled
MF_SeparatorInt32menu separator
NM_ClickInt32
NM_DoubleClickInt32
NM_FirstInt32
NM_KillFocusInt32
NM_OutOfMemoryInt32
NM_ReturnInt32
NM_RightClickInt32
NM_RightDoubleClickInt32
NM_SetFocusInt32
ORIENT_SPLIT_HorizontalInt32
ORIENT_SPLIT_UnsetInt32
ORIENT_SPLIT_VerticalInt32
PAL_EnableMRUColorsInt32
PAL_NoHideSelectsInt32
PALETTE_MainInt32
PALETTE_MRUInt32
PALN_ChangedInt32
PALN_ErrSpaceInt32
PALN_FinishedInt32
PALN_MenuInt32
PIC_LoadFileInt32
PIC_LoadLargeIconInt32
PIC_LoadResourceInt32
PIC_LoadSmallIconInt32
PIC_LoadSWinResInt32
PIC_LoadSWinStrInt32
PicDesktopSalNumberImage used to represent the desktop node in the VisDesktopListBox control.
PicDriveCDSalNumberCD drive
PicDriveFixedSalNumberfixed drive
PicDriveFloppySalNumberfloppy drive
PicDriveNetworkSalNumbernetwork drive
PicDriveRemovableSalNumberremovable drive
PicFolderClosedSalNumberImage used to represent a closed node in the VisOutlineListBox control.
PicFolderOpenSalNumberImage used to represent an open node in the VisOutlineListBox control.
PicMyComputerSalNumberImage used to represent the computer node in the VisDesktopListBox control.
PicNetworkNeighborhoodSalNumberImage used to represent the network neighborhood node in the VisDesktopListBox control.
PicTTFontSalNumberthe image used to populate the fonts
REF_AutoHScrollInt32
REF_AutoVScrollInt32
REF_AutoWordSelectionInt32
REF_CFE_AutoColorInt32
REF_CFE_BoldInt32
REF_CFE_ItalicInt32
REF_CFE_ProtectedInt32
REF_CFE_StrikeoutInt32
REF_CFE_UnderlineInt32
REF_FT_MatchCaseInt32matches case
REF_FT_WholeWordInt32matches whole word
REF_NoHideSelInt32
REF_PFA_CenterInt32
REF_PFA_LeftInt32
REF_PFA_RightInt32
REF_PFN_BulletInt32Paragraph Format Numbering Flags (duplicates of PFN_ constants from Microsoft's RICHEDIT.H)
REF_ReadOnlyInt32
REF_SaveSelectionInt32
REF_SEL_EmptyInt32
REF_SEL_MultiCharInt32
REF_SEL_MultiObjectInt32
REF_SEL_ObjectInt32
REF_SEL_TextInt32
REF_VerticalInt32
REGION_MainInt32
REGION_MenuInt32
REGION_MRUInt32
REN_ChangeInt32
REN_ErrSpaceInt32
REN_HScrollInt32
REN_MaxTextInt32
REN_ProtectedInt32
REN_RequestResizeInt32
REN_SelChangeInt32
REN_UpdateInt32
REN_VScrollInt32
ROW_UserFlag1Int32
ROW_UserFlag2Int32
ROW_UserFlag3Int32
ROW_UserFlag4Int32
ROW_UserFlag5Int32
SEEK_BeginInt32
SEEK_CurrentInt32
SEEK_EndInt32
SEQ_FirstInt32
SEQ_FourthInt32
SEQ_LastInt32
SEQ_SecondInt32
SEQ_ThirdInt32
SEQ_UnsetInt32
SHOW_AllLevelsInt32Show All Levels
SHOW_HiddenInt32
SHOW_MaximizedInt32
SHOW_MinimizedInt32
SHOW_NormalInt32
SM_DBCSEnabledInt32
SM_DebugInt32
SM_MenuDropAlignmentInt32
SM_MousePresentInt32
SM_PenWindowsInt32
SM_SwapButtonInt32
SM_XBorderInt32
SM_XCursorInt32
SM_XDlgFrameInt32
SM_XDoubleClickInt32
SM_XFrameInt32
SM_XFullScreenInt32
SM_XHScrollInt32
SM_XHThumbInt32
SM_XIconInt32
SM_XIconSpacingInt32
SM_XMinInt32
SM_XMinTrackInt32
SM_XScreenInt32
SM_XSizeInt32
SM_XVScrollInt32
SM_YBorderInt32
SM_YCaptionInt32
SM_YCursorInt32
SM_YDlgFrameInt32
SM_YDoubleClickInt32
SM_YFrameInt32
SM_YFullScreenInt32
SM_YHScrollInt32
SM_YIconInt32
SM_YIconSpacingInt32
SM_YKanjiWindowInt32
SM_YMenuInt32
SM_YMinInt32
SM_YMinTrackInt32
SM_YScreenInt32
SM_YSizeInt32
SM_YVScrollInt32
SM_YVThumbInt32
SORT_AscendingInt32Sort ascending flag for ArraySort.
SORT_DescendingInt32Sort descending flag for ArraySort
SPECIAL_MonthlyDOMInt32
SPECIAL_MonthlyDOWInt32
SPECIAL_OneTimeInt32
SPECIAL_UnsetInt32
SPECIAL_WeeklyInt32
SPECIAL_YearlyInt32
SPECIAL_YearlyDOWInt32
VK_0Int32
VK_1Int32
VK_2Int32
VK_3Int32
VK_4Int32
VK_5Int32
VK_6Int32
VK_7Int32
VK_8Int32
VK_9Int32
VK_AInt32
VK_AddInt32
VK_AltInt32
VK_BInt32
VK_BackspaceInt32
VK_CInt32
VK_CancelInt32
VK_CapsLockInt32
VK_ClearInt32
VK_ControlInt32
VK_DInt32
VK_DecimalInt32
VK_DeleteInt32
VK_DivideInt32
VK_DownInt32
VK_EInt32
VK_EndInt32
VK_EnterInt32
VK_EscapeInt32
VK_ExecuteInt32
VK_FInt32
VK_F1Int32
VK_F10Int32
VK_F11Int32
VK_F12Int32
VK_F2Int32
VK_F3Int32
VK_F4Int32
VK_F5Int32
VK_F6Int32
VK_F7Int32
VK_F8Int32
VK_F9Int32
VK_GInt32
VK_HInt32
VK_HelpInt32
VK_HomeInt32
VK_IInt32
VK_InsertInt32
VK_JInt32
VK_KInt32
VK_LInt32
VK_LeftInt32
VK_LeftButtonInt32
VK_MInt32
VK_MiddleButtonInt32
VK_MultiplyInt32
VK_NInt32
VK_NumLockInt32
VK_OInt32
VK_PInt32
VK_PageDownInt32
VK_PageUpInt32
VK_PauseInt32
VK_PrintScreenInt32
VK_QInt32
VK_RInt32
VK_RightInt32
VK_RightButtonInt32
VK_SInt32
VK_ScrollLockInt32
VK_SelectInt32
VK_SeparatorInt32
VK_ShiftInt32
VK_SpaceInt32
VK_SubtractInt32
VK_TInt32
VK_TabInt32
VK_UInt32
VK_UpInt32
VK_VInt32
VK_WInt32
VK_XInt32
VK_YInt32
VK_ZInt32
VT_DLLNameString
VT_SWP_NoZOrderInt32Show Window Flags
VTERR_AccessDeniedInt32
VTERR_BadNetNameInt32
VTERR_BadNetPathInt32
VTERR_DiskFullInt32
VTERR_DriveNotReadyInt32
VTERR_EndOfFileInt32
VTERR_FileNotFoundInt32
VTERR_InvalidDataInt32
VTERR_InvalidDriveInt32
VTERR_InvalidHandleInt32
VTERR_InvalidParameterInt32
VTERR_LockViolationInt32
VTERR_NetNameDeletedInt32
VTERR_NetworkAccessDeniedInt32
VTERR_NetworkBusyInt32
VTERR_NetworkUnreachableInt32
VTERR_NetWriteFaultInt32
VTERR_NoMemoryInt32
VTERR_NoMoreFilesInt32
VTERR_OkInt32
VTERR_PathNotFoundInt32
VTERR_ReadFaultInt32
VTERR_SharingViolationInt32
VTERR_TooManyFilesInt32
VTERR_WriteFaultInt32
VTERR_WriteProtectedInt32
VTM_AcceleratorInt32
VTM_BaseInt32
VTM_CharInt32
VTM_ClickInt32
VTM_ControlCreateInt32
VTM_CreateInt32
VTM_CreateCompleteInt32
VTM_DestroyInt32
VTM_EnableInt32
VTM_EraseBkgndInt32
VTM_KeyDownInt32
VTM_KeyUpInt32
VTM_LeftClickInt32
VTM_LeftDoubleClickInt32
VTM_LVColumnClickInt32! ***message returning Column header clicked
VTM_MenuSelectInt32
VTM_MiddleClickInt32
VTM_MiddleDoubleClickInt32
VTM_OutlineCornerClickInt32
VTM_PopulateInt32
VTM_RightClickInt32
VTM_RightDoubleClickInt32
VTM_SizeInt32
VTM_SpinGetValueInt32
VTM_SpinScrollDownInt32
VTM_SpinScrollUpInt32
VTM_SpinSetIncrementInt32
VTM_SpinSetMaxInt32
VTM_SpinSetMinInt32
VTM_SpinSetValueInt32
VTPIC_BookClosedString
VTPIC_BookOpenString
VTPIC_BookShelf2String
VTPIC_BookShelf3String
VTPIC_CheckBlackString
VTPIC_CheckBoxOffString
VTPIC_CheckBoxOnString
VTPIC_CheckWhiteString
VTPIC_DesktopString
VTPIC_DiamondBlackClosedString
VTPIC_DiamondBlackOpenString
VTPIC_DiamondWhiteClosedString
VTPIC_DiamondWhiteOpenString
VTPIC_DriveCDROMString
VTPIC_DriveCDROM2String
VTPIC_DriveFixedString
VTPIC_DriveFloppyString
VTPIC_DriveNetworkString
VTPIC_DriveNetworkXString
VTPIC_DriveRAMString
VTPIC_EmptyString
VTPIC_FileAllOtherString
VTPIC_FileDocumentsString
VTPIC_FileProgramsString
VTPIC_FileSystemString
VTPIC_FolderString
VTPIC_Folder2String
VTPIC_FolderCurString
VTPIC_FolderCurMinusString
VTPIC_FolderCurPlusString
VTPIC_FolderMinusString
VTPIC_FolderOpenString
VTPIC_FolderOpen2String
VTPIC_FolderPlusString
VTPIC_FontPrinterString
VTPIC_FontTrueTypeString
VTPIC_MinusDarkString
VTPIC_MinusLightString
VTPIC_MinusWhiteString
VTPIC_MyComputerString
VTPIC_NetworkNeighborhoodString
VTPIC_PlusDarkString
VTPIC_PlusLightString
VTPIC_PlusWhiteString
VTPIC_PrevDirectoryString
VTPIC_RadioOffString
VTPIC_RadioOnString
WAIT_SysModalOffInt32
WAIT_SysModalOnInt32
WAIT_TempOffInt32
WAIT_TempOnInt32
WF_80x87Int32
WF_CPU286Int32
WF_CPU386Int32
WF_CPU486Int32
WF_DisplayOnlyInt32
WF_EnableWhenNotNullInt32
WF_EnhancedInt32
WF_FitPathInt32
WF_NoClearInt32
WF_NoClearEditFlagInt32
WF_PagingInt32
WF_PModeInt32
WF_RequiredInt32Window Flags
WF_StandardInt32
WF_WLOInt32

Methods

Static memberArrayAppend(SourceArray, TargetArray, dataType)

Appends one array to the end of another array.

ParameterTypeDescription
SourceArraySalArray
TargetArraySalArray
dataTypeSalNumber

Returns: SalNumber.

Static memberArrayCopy(SourceArray, TargetArray, dataType)

Copies the source array to the target array.

ParameterTypeDescription
SourceArraySalArray
TargetArraySalArray
dataTypeSalNumber

Returns: SalNumber.

Static memberArrayDeleteItem(array, index, dataType)

Deletes an item from an array.

ParameterTypeDescription
arraySalArray
indexSalNumber
dataTypeSalNumber

Returns: SalNumber.

Static memberArrayFillDateTime(array, value, count)

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

ParameterTypeDescription
arraySalArray<SalDateTime>
valueSalDateTime
countSalNumber

Returns: SalBoolean.

Static memberArrayFillNumber(array, value, count)

Fills a Number array with the specified numeric value.

ParameterTypeDescription
arraySalArray<SalNumber>
valueSalNumber
countSalNumber

Returns: SalBoolean.

Static memberArrayFillString(array, value, count)

Fills a String array with the specified string value.

ParameterTypeDescription
arraySalArray<SalString>
valueSalString
countSalNumber

Returns: SalBoolean.

Static memberArrayFindDateTime(array, searchFor)

Locates a date/time value within an array.

ParameterTypeDescription
arraySalArray<SalDateTime>
searchForSalDateTime

Returns: SalNumber.

Static memberArrayFindNumber(array, searchFor)

Locates a numeric value within an array.

ParameterTypeDescription
arraySalArray<SalNumber>
searchForSalNumber

Returns: SalNumber.

Static memberArrayFindNumber(array, searchFor)

Locates a numeric value within an array.

ParameterTypeDescription
arraySalArray<SalBoolean>
searchForSalBoolean

Returns: SalNumber.

Static memberArrayFindString(array, searchFor)

Locates a string value within an array.

ParameterTypeDescription
arraySalArray<SalString>
searchForSalString

Returns: SalNumber.

Static memberArrayInsertItem(array, index, dataType)

Inserts an item into an array.

ParameterTypeDescription
arraySalArray
indexSalNumber
dataTypeSalNumber

Returns: SalNumber.

Static memberArraySort(array, sortOrder, dataType)

Sorts an array.

ParameterTypeDescription
arraySalArray
sortOrderSalNumber
dataTypeSalNumber

Returns: SalNumber.

Static memberDebugAssert(expression, DebugString)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
expressionSalBoolean
DebugStringSalString

Returns: SalBoolean.

Static memberDebugBeginTime()

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

Returns: SalBoolean.

Static memberDebugEndTime(Context, DebugLevel)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
ContextSalString
DebugLevelSalNumber

Returns: SalBoolean.

Static memberDebugGetFlags()

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

Returns: SalNumber.

Static memberDebugSetFlags(Flags, Mode)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
FlagsSalNumber
ModeSalBoolean

Returns: SalNumber.

Static memberDebugSetLevel(DebugLevel)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
DebugLevelSalNumber

Returns: SalBoolean.

Static memberDebugSetTime(Context)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
ContextSalString

Returns: SalBoolean.

Static memberDebugString(DebugString, DebugLevel)

Deprecated memberDeprecated: Use System.Diagnostics.Debug Not supported.

ParameterTypeDescription
DebugStringSalString
DebugLevelSalNumber

Returns: SalBoolean.

Static memberDosBuildFullName(moduleName, fileName)

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

ParameterTypeDescription
moduleNameSalString
fileNameSalString

Returns: SalString.

Static memberDosEnumDirInfo(dirSpec, dirs, dateTimes, attributes)

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

ParameterTypeDescription
dirSpecSalString
dirsSalArray<SalString>
dateTimesSalArray<SalDateTime>
attributesSalArray<SalNumber>

Returns: SalNumber.

Static memberDosEnumDirs(dirSpec, dirs)

Enumerates all the directories using the specified wild card.

ParameterTypeDescription
dirSpecSalString
dirsSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumDrives(drives)

Enumerates all the logical drives.

ParameterTypeDescription
drivesSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumFileInfo(fileSpec, attribute, files, sizes, dateTimes, attributes)

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

ParameterTypeDescription
fileSpecSalString
attributeSalNumber
filesSalArray<SalString>
sizesSalArray<SalNumber>
dateTimesSalArray<SalDateTime>
attributesSalArray<SalNumber>

Returns: SalNumber.

Static memberDosEnumFiles(fileSpec, attributes, files)

Enumerates all the files using the specified wild card.

ParameterTypeDescription
fileSpecSalStringFile name or file pattern of the files to retrieve.
attributesSalNumberThe attributes of the files to retrieve.
filesSalArray<SalString>Returns the names of the files that match the specified name and attributes.

Returns: SalNumber.

Static memberDosEnumNetConnections(devices, netNames)

Enumerates all the network connections.

ParameterTypeDescription
devicesSalArray<SalString>
netNamesSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumPath(directories)

Enumerates all the paths in the PATH environment variable.

ParameterTypeDescription
directoriesSalArray<SalString>

Returns: SalNumber.

Static memberDosExist(fileSpec)

Checks if the specified directory exists.

ParameterTypeDescription
fileSpecSalStringThe path of the file or director to check.

Returns: SalBoolean.

Static memberDosGetCurDir(drive)

Returns the current directory.

ParameterTypeDescription
driveSalString

Returns: SalString.

Static memberDosGetDriveSize(drive, totalSpace, freeSpace)

ParameterTypeDescription
driveSalString
totalSpaceSalNumber&
freeSpaceSalNumber&

Returns: SalNumber.

Static memberDosGetDriveType(drive)

Returns the type of the specified drive.

ParameterTypeDescription
driveSalStringThe drive letter to check.

Returns: SalNumber.

Static memberDosGetEnvString(name)

Gets environment value for the specified name .

ParameterTypeDescription
nameSalStringThe name of the environment variable to read.

Returns: SalString.

Static memberDosGetFlags()

Deprecated memberDeprecated: Flags VisDosGetFlags ()

Returns: SalNumber.

Static memberDosGetNetName(device)

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

ParameterTypeDescription
deviceSalString

Returns: SalString.

Static memberDosGetVersion()

Returns the OS version.

Returns: SalNumber.

Static memberDosGetVolumeLabel(drive)

Returns the volume label of the specified drive.

ParameterTypeDescription
driveSalStringThe drive letter for which to read the volume label.

Returns: SalString.

Static memberDosIsParent(dirSpec)

Returns TRUE if directory contains subdirectories

ParameterTypeDescription
dirSpecSalStringThe name of the directory; or empty for the current directory.

Returns: SalBoolean.

Static memberDosMakeAllDir(dir)

Makes directory including all subdirectories.

ParameterTypeDescription
dirSalStringPath name of the directory and subdirectories to create.

Returns: SalNumber.

Static memberDosMakePath(drive, dir, baseStr, ext)

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

ParameterTypeDescription
driveSalString
dirSalString
baseStrSalString
extSalString

Returns: SalString.

Static memberDosNetConnect(device, netName, password)

Makes a connection to a network resource.

ParameterTypeDescription
deviceSalString
netNameSalString
passwordSalString

Returns: SalNumber.

Static memberDosNetDisconnect(device, force)

Disconnect a connection

ParameterTypeDescription
deviceSalString
forceSalBoolean

Returns: SalNumber.

Static memberDosSetFlags(Flags, state)

Deprecated memberDeprecated: Not supported.

ParameterTypeDescription
FlagsSalNumber
stateSalBoolean

Returns: SalNumber.

Static memberDosSetVolumeLabel(drive, label)

Sets the label of a file system volume.

ParameterTypeDescription
driveSalString
labelSalString

Returns: SalNumber.

Static memberDosSplitPath(fileSpec, drive, dir, baseStr, ext)

ParameterTypeDescription
fileSpecSalString
driveSalString&
dirSalString&
baseStrSalString&
extSalString&

Returns: SalNumber.

Static memberErrorRecovery(Caption)

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

ParameterTypeDescription
CaptionSalString

Returns: SalNumber.

Static memberFileAppend(sourceFile, targetFile)

Appends one file to another.

ParameterTypeDescription
sourceFileSalString
targetFileSalString

Returns: SalNumber.

Static memberFileClose(file)

Closes a file.

ParameterTypeDescription
fileSalFileHandle

Returns: SalNumber.

Static memberFileCopy(sourceFile, targetFile)

Copies a file

ParameterTypeDescription
sourceFileSalString
targetFileSalString

Returns: SalNumber.

Static memberFileCreateTemp(prefix)

Gets a new temp file name.

ParameterTypeDescription
prefixSalString

Returns: SalString.

Static memberFileDelete(fileName)

Deletes a file.

ParameterTypeDescription
fileNameSalString

Returns: SalNumber.

Static memberFileExpand(sourceFile, targetFile)

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

ParameterTypeDescription
sourceFileSalString
targetFileSalString

Returns: SalNumber.

Static memberFileFind(fileName)

Searches for a file.

ParameterTypeDescription
fileNameSalString

Returns: SalString.

Static memberFileGetAttribute(fileName)

Gets the attribute bit values for the specified file.

ParameterTypeDescription
fileNameSalString

Returns: SalNumber.

Static memberFileGetSize(fileName)

Gets the size of the specified file.

ParameterTypeDescription
fileNameSalString

Returns: SalNumber.

Static memberFileGetType(fileName)

Gets the type of the specified file.

ParameterTypeDescription
fileNameSalString

Returns: SalNumber.

Static memberFileOpen(file, fileName, flags)

ParameterTypeDescription
fileSalFileHandle&
fileNameSalString
flagsSalNumber

Returns: SalNumber.

Static memberFileRead(file, buffer, size)

ParameterTypeDescription
fileSalFileHandle
bufferSalString&
sizeSalNumber

Returns: SalNumber.

Static memberFileReadBinary(file, buffer, numBytes)

ParameterTypeDescription
fileSalFileHandle
bufferSalBinary&
numBytesSalNumber

Returns: SalNumber.

Static memberFileReadString(file, line)

ParameterTypeDescription
fileSalFileHandle
lineSalString&

Returns: SalNumber.

Static memberFileRename(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.

ParameterTypeDescription
sourceFileSalString
targetFileSalString

Returns: SalNumber.

Static memberFileSeek(file, offset, origin)

Positions within a file.

ParameterTypeDescription
fileSalFileHandle
offsetSalNumber
originSalNumber

Returns: SalNumber.

Static memberFileSetAttribute(fileName, attributes, state)

Sets attributes for a file.

ParameterTypeDescription
fileNameSalString
attributesSalNumber
stateSalBoolean

Returns: SalNumber.

Static memberFileSetDateTime(fileName, dateTime)

Sets datetime of a file.

ParameterTypeDescription
fileNameSalString
dateTimeSalDateTime

Returns: SalNumber.

Static memberFileTell(file)

Returns current offset in an open file.

ParameterTypeDescription
fileSalFileHandle

Returns: SalNumber.

Static memberFileWrite(file, buffer, size)

Writes a buffer to a file.

ParameterTypeDescription
fileSalFileHandle
bufferSalString
sizeSalNumber

Returns: SalNumber.

Static memberFileWriteBinary(file, buffer)

Writes the binary buffer to the file.

ParameterTypeDescription
fileSalFileHandle
bufferSalBinary

Returns: SalNumber.

Static memberFileWriteString(file, line)

Writes the line of text to the file.

ParameterTypeDescription
fileSalFileHandle
lineSalString

Returns: SalNumber.

Static memberFontEnum(Type, Names, Types)

Enumerates all the installed fonts.

ParameterTypeDescription
TypeSalNumber
NamesSalArray<SalString>
TypesSalArray<SalNumber>

Returns: SalNumber.

Static memberFontFree(fontHandle)

Release the font handle.

ParameterTypeDescription
fontHandleSalNumber

Returns: SalBoolean.

Static memberFontGet(fontHandle, faceName, pointSize, fontFlags)

ParameterTypeDescription
fontHandleSalNumber
faceNameSalString&
pointSizeSalNumber&
fontFlagsSalNumber&

Returns: SalBoolean.

Static memberFontLoad(faceName, pointSize, enhFlags)

Loads the specified font.

ParameterTypeDescription
faceNameSalString
pointSizeSalNumber
enhFlagsSalNumber

Returns: SalNumber.

Static memberGetCommonDir(ctrl, index)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalString.

Static memberGetCopyright()

Retrieves a copyright string.

Returns: SalString.

Static memberGetKeyState(VirtKey)

Retrieves the state of a specified key.

ParameterTypeDescription
VirtKeySalNumber

Returns: SalNumber.

Static memberGetSystemMetrics(index)

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

ParameterTypeDescription
indexSalNumber

Returns: SalNumber.

Static memberGetVersion()

Gets version information.

Returns: SalString.

Static memberGetWiFlags()

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

Returns: SalNumber.

Static memberGetWinVersion()

Gets windows version information.

Returns: SalNumber.

Static memberListAddColor(ctrl, text, color)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
colorSalNumber

Returns: SalNumber.

Static memberListAddColorValue(ctrl, text, color, value)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
colorSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListAddFont(ctrl, text, fontHandle)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
fontHandleSalNumber

Returns: SalNumber.

Static memberListAddFontValue(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
fontHandleSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListAddPicture(ctrl, text, picNormal, picSelected)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
picNormalSalNumber
picSelectedSalNumber

Returns: SalNumber.

Static memberListAddPictureValue(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
picNormalSalNumber
picSelectedSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListAddValue(ctrl, text, value)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
valueSalNumber

Returns: SalNumber.

Static memberListArrayPopulate(ctrl, items)

Populates a list box from a string array.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemsSalArray<SalString>

Returns: SalNumber.

Static memberListArrayPopulateValue(ctrl, items, values)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemsSalArray<SalString>
valuesSalArray<SalNumber>

Returns: SalNumber.

Static memberListClearSelection(ctrl)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalBoolean.

Static memberListCollapse(ctrl, index)

Collapses all descendant items.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalBoolean.

Static memberListDeleteChild(ctrl, index)

Deletes the child item from the tree control.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListDeleteDescendents(ctrl, index)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListDeleteSelected(ctrl)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberListDemote(ctrl, index, picNormal, picSelect)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
picNormalSalNumber
picSelectSalNumber

Returns: SalBoolean.

Static memberListDisableItem(ctrl, index, color)

Disables the specified item and sets the specified color.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
colorSalNumber

Returns: SalNumber.

Static memberListDragDrop(ctrl, sourceIndex, targetCtrl, targetIndex, dropFlags)

Implements drag and drop

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sourceIndexSalNumber
targetCtrlControl
targetIndexSalNumber
dropFlagsSalNumber

Returns: SalBoolean.

Static memberListEnableItem(ctrl, index, color)

Enables the specified item and sets the specified color.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
colorSalNumber

Returns: SalNumber.

Static memberListEnumChildren(item, items)

Enumerates child item handles for a specified item.

ParameterTypeDescription
itemSalNumber
itemsSalArray<SalNumber>

Returns: SalNumber.

Static memberListEnumDescendents(item, items)

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

ParameterTypeDescription
itemSalNumber
itemsSalArray<SalNumber>

Returns: SalNumber.

Static memberListExpand(ctrl, index)

Expands an outline one level at the index specified.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListExpandDescendents(ctrl, index)

Displays all descendants of an item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalBoolean.

Static memberListFindItemValue(item, value)

Finds list item by value

ParameterTypeDescription
itemSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListFindString(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
startIndexSalNumber
textSalString

Returns: SalNumber.

Static memberListFindValue(ctrl, startIndex, value)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
startIndexSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListFreeChild(item)

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

ParameterTypeDescription
itemSalNumber

Returns: SalBoolean.

Static memberListFreeDescendents(item)

Frees memory for all descendants of the item specified.

ParameterTypeDescription
itemSalNumber

Returns: SalBoolean.

Static memberListGetColor(ctrl, index)

Returns the current color of the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListGetDropdownState(ctrl)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalBoolean.

Static memberListGetFlags(ctrl, index)

Returns the ITEM_* flags for the specified list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListGetFocusIndex(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberListGetFont(ctrl, index)

Returns the current font of the list control item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListGetIndexFromPoint(ctrl, X, Y)

Gets list index from a point

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
XSalNumber
YSalNumber

Returns: SalNumber.

Static memberListGetItemColor(item)

Retrieves the color associated with an outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetItemData(item, text, value, itemFlags)

ParameterTypeDescription
itemSalNumber
textSalString&
valueSalNumber&
itemFlagsSalNumber&

Returns: SalBoolean.

Static memberListGetItemFlags(item)

Gets item flags

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetItemFont(item)

Retrieves the font associated with an outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetItemHandle(ctrl, index)

Retrieves the item handle based on an index specified.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListGetItemIndex(item)

Returns the index of the specified outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetItemPicture(item, picNormal, picSelect)

ParameterTypeDescription
itemSalNumber
picNormalSalNumber&
picSelectSalNumber&

Returns: SalBoolean.

Static memberListGetItemText(item)

Returns the text for the outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalString.

Static memberListGetItemValue(item)

Returns the value saved with the outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetLevel(item)

Returns the level number for an outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetNextSibling(item)

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

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetParent(item)

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

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetPicture(ctrl, index, picNormal, picSelected)

ParameterTypeDescription
ctrlControl
indexSalNumber
picNormalSalNumber&
picSelectedSalNumber&

Returns: SalNumber.

Static memberListGetPrevSibling(item)

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

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetRoot(ctrl)

Returns the handle for the root node.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberListGetStyle(ctrl)

Returns the LBS_* style for the specified control.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberListGetText(ctrl, index)

Returns the text of the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalString.

Static memberListGetTextRectangle(ctrl, index, top, left, bottom, right)

ParameterTypeDescription
ctrlControl
indexSalNumber
topSalNumber&
leftSalNumber&
bottomSalNumber&
rightSalNumber&

Returns: SalBoolean.

Static memberListGetValue(ctrl, index)

Returns the value associated to the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListGetVisibleRange(ctrl, top, bottom)

ParameterTypeDescription
ctrlControl
topSalNumber&
bottomSalNumber&

Returns: SalNumber.

Static memberListInsertColor(ctrl, index, text, color)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
colorSalNumber

Returns: SalNumber.

Static memberListInsertColorValue(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
colorSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListInsertFont(ctrl, index, text, fontHandle)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
fontHandleSalNumber

Returns: SalNumber.

Static memberListInsertFontValue(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
fontHandleSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListInsertPicture(ctrl, index, text, picNormal, picSelected)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
picNormalSalNumber
picSelectedSalNumber

Returns: SalNumber.

Static memberListInsertPictureValue(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
picNormalSalNumber
picSelectedSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListInsertValue(ctrl, index, text, value)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString
valueSalNumber

Returns: SalNumber.

Static memberListIsMultiSelect(ctrl)

Returns true if the list box is multi select.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalBoolean.

Static memberListLoadChild(ctrl, itemParent, picNormal, picSelect, text, value, itemFlags)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemParentSalNumber
picNormalSalNumber
picSelectSalNumber
textSalString
valueSalNumber
itemFlagsSalNumber

Returns: SalNumber.

Static memberListLoadChildren(ctrl, itemParent, picNormal, picSelect, texts, values, itemFlags)

Loads with arrays from children

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemParentSalNumber
picNormalSalNumber
picSelectSalNumber
textsSalArray<SalString>
valuesSalArray<SalNumber>
itemFlagsSalArray<SalNumber>

Returns: SalNumber.

Static memberListLoadOutline(ctrl, blob)

Load outline from a blob

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
blobSalString

Returns: SalNumber.

Static memberListLoadOutlineFile(ctrl, fileName, picParentNormal, picParentSelect, picChildNormal, picChildSelect)

Load outline from a file

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
fileNameSalString
picParentNormalSalNumber
picParentSelectSalNumber
picChildNormalSalNumber
picChildSelectSalNumber

Returns: SalNumber.

Static memberListLoadSibling(ctrl, itemBefore, picNormal, picSelect, text, value, itemFlags)

Load sibling

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemBeforeSalNumber
picNormalSalNumber
picSelectSalNumber
textSalString
valueSalNumber
itemFlagsSalNumber

Returns: SalNumber.

Static memberListMoveDown(ctrl, index)

Move item down

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalBoolean.

Static memberListMoveUp(ctrl, index)

Move item up

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalBoolean.

Static memberListPromote(ctrl, index, picNormal, picSelect)

Promote item

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
picNormalSalNumber
picSelectSalNumber

Returns: SalBoolean.

Static memberListSaveOutline(ctrl, blob)

ParameterTypeDescription
ctrlControl
blobSalString&

Returns: SalNumber.

Static memberListScroll(ctrl, index)

Scrolls an item into view.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListSetColor(ctrl, index, color)

Sets the color of a list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
colorSalNumber

Returns: SalBoolean.

Static memberListSetDropdownState(ctrl, state)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
stateSalBoolean

Returns: SalBoolean.

Static memberListSetFlags(ctrl, index, itemFlags, state)

Sets the ITEM_* flags for the specified list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
itemFlagsSalNumber
stateSalBoolean

Returns: SalNumber.

Static memberListSetFocusIndex(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.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListSetFont(ctrl, index, fontHandle)

Sets the font of the list control item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
fontHandleSalNumber

Returns: SalBoolean.

Static memberListSetIndent(ctrl, indent)

Set list indentation

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indentSalNumber

Returns: SalBoolean.

Static memberListSetItemColor(item, color)

Sets the color of the outline item.

ParameterTypeDescription
itemSalNumber
colorSalNumber

Returns: SalBoolean.

Static memberListSetItemData(ctrl, item, text, value, itemFlags)

Updates the specified item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemSalNumber
textSalString
valueSalNumber
itemFlagsSalNumber

Returns: SalNumber.

Static memberListSetItemFlags(item, itemFlags, state)

Sets item flags

ParameterTypeDescription
itemSalNumber
itemFlagsSalNumber
stateSalBoolean

Returns: SalBoolean.

Static memberListSetItemFont(item, fontHandle)

Sets the font of the outline item.

ParameterTypeDescription
itemSalNumber
fontHandleSalNumber

Returns: SalBoolean.

Static memberListSetItemPicture(item, picNormal, picSelect)

Sets the picture of a list item

ParameterTypeDescription
itemSalNumber
picNormalSalNumber
picSelectSalNumber

Returns: SalBoolean.

Static memberListSetItemText(item, text)

Sets the text of the outline item.

ParameterTypeDescription
itemSalNumber
textSalString

Returns: SalBoolean.

Static memberListSetItemValue(item, value)

Sets the value associated to the outline item.

ParameterTypeDescription
itemSalNumber
valueSalNumber

Returns: SalBoolean.

Static memberListSetOutlineRedraw(ctrl, redraw)

Sets outline redraw

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
redrawSalBoolean

Returns: SalBoolean.

Static memberListSetPicture(ctrl, index, picNormal, picSelected)

Changes the normal and selected images for the specified item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
picNormalSalNumber
picSelectedSalNumber

Returns: SalBoolean.

Static memberListSetScrollWidth(ctrl, index)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalNumber.

Static memberListSetStyle(ctrl, style, lParam)

Sets the LBS_* style of the specified control.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
styleSalNumber
lParamSalNumber

Returns: SalBoolean.

Static memberListSetText(ctrl, index, text)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
textSalString

Returns: SalNumber.

Static memberListSetValue(ctrl, index, value)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListShowOutline(ctrl, level)

Expands list items up to the specified level.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
levelSalNumber

Returns: SalBoolean.

Checks the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Removes the menu at the requested position.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Disables the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Enables the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Returns the number of items in the specified menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber

Returns: SalNumber.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Retrieves the menu handle of a pop-up menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalNumber.

Deprecated memberDeprecated: Not supported.

ParameterTypeDescription
ctrlSalWindowHandleTarget control on which to execute the call.

Returns: SalNumber.

Retrieves the text of a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalString.

Inserts a menu item into a menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
textSalString
flagsSalNumber

Returns: SalNumber.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
fontHandleSalNumber
textSalString

Returns: SalNumber.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
picNormalSalNumber
picSelectedSalNumber
textSalString

Returns: SalNumber.

Returns true if the menu is checked.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Returns true if the menu is enabled.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
fontHandleSalNumber
textSalString

Returns: SalBoolean.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
picNormalSalNumber
picSelectedSalNumber
textSalString

Returns: SalBoolean.

Changes the text of a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber
textSalString

Returns: SalBoolean.

Unchecks a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
menuSalNumber
posSalNumber

Returns: SalBoolean.

Static memberMessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons)

Displays a message box with user defined buttons.

ParameterTypeDescription
sMsgTextSalStringText to display in the MessageBox/
sCaptionSalStringTitle of the MessageBox.
hPicIconSalNumberHandle of the icon to display in the MessageBox.
hBtnHandlesSalArray<SalNumber>List of MessageBox buttons created using MessageLoadButton.
nNumButtonsSalNumberNumber of MessageBox buttons in hBtnHandles .

Returns: SalNumber.

Static memberMessageBox(sMsgText, sCaption, hPicIcon, hBtnHandles, nNumButtons, nDefButtonIndex)

Displays a message box with user defined buttons.

ParameterTypeDescription
sMsgTextSalStringText to display in the MessageBox/
sCaptionSalStringTitle of the MessageBox.
hPicIconSalNumberHandle of the icon to display in the MessageBox.
hBtnHandlesSalArray<SalNumber>List of MessageBox buttons created using MessageLoadButton.
nNumButtonsSalNumberNumber of MessageBox buttons in hBtnHandles .
nDefButtonIndexSalNumberIndex of the default button in hBtnHandles .

Returns: SalNumber.

Static memberMessageFreeButton(button)

Frees the previously created MessageBox button.

ParameterTypeDescription
buttonSalNumber

Returns: SalBoolean.

Static memberMessageLoadButton(label, id)

Creates a button to be used in the MessageBox.

ParameterTypeDescription
labelSalString
idSalNumber

Returns: SalNumber.

Static memberMessageSetBkgdColor(color)

Sets the background color for the customized message box.

ParameterTypeDescription
colorSalNumber

Returns: SalBoolean.

Static memberNumberBitClear(value, bitMask)

ParameterTypeDescription
valueSalNumber&
bitMaskSalNumber

Returns: SalNumber.

Static memberNumberBitSet(value, bitMask)

ParameterTypeDescription
valueSalNumber&
bitMaskSalNumber

Returns: SalNumber.

Static memberNumberChoose(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.

ParameterTypeDescription
expressionSalBoolean
trueValueSalNumber
falseValueSalNumber

Returns: SalNumber.

Static memberNumberHighByte(num)

Returns the HighByte of a number

ParameterTypeDescription
numSalNumber

Returns: SalNumber.

Static memberNumberLowByte(num)

Returns the LowByte of a number

ParameterTypeDescription
numSalNumber

Returns: SalNumber.

Static memberNumberMakeLong(lowWord, highWord)

Combines a LowWord and a HighWord to a Long

ParameterTypeDescription
lowWordSalNumber
highWordSalNumber

Returns: SalNumber.

Static memberPicFree(Pic)

Removes a picture and frees it's memory.

ParameterTypeDescription
PicSalNumber

Returns: SalNumber.

Static memberPicLoad(flags, resource, imageName)

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

ParameterTypeDescription
flagsSalNumber
resourceSalString
imageNameSalString

Returns: SalNumber.

Static memberPopulateCommonDir(ctrl, directory)

Adds all directories to a list box or combo box.

ParameterTypeDescription
ctrlControlA control implementing the ISalListControl interface.
directorySalStringPath to the root directory.

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

Static memberPopulateDirTree(ctrl, directory)

Populates the tree control with the specified directories.

ParameterTypeDescription
ctrlControlA control that inherits the VisListBoxExtension class.
directorySalStringPath to the root directory.

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

Static memberPopulateDrives(ctrl)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberPopulateFontNames(ctrl, fontType)

Populates the control with the names of all the fonts.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
fontTypeSalNumberNot used

Returns: SalNumber.

Static memberProfileDelete(fileName, section, entry)

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

ParameterTypeDescription
fileNameSalString
sectionSalString
entrySalString

Returns: SalBoolean.

Static memberProfileEnumStrings(fileName, section, strings)

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

ParameterTypeDescription
fileNameSalString
sectionSalString
stringsSalArray<SalString>

Returns: SalNumber.

Static memberSendMsgString(hWnd, message, wParam, lParam)

Sends a message and passes a string in the lParam.

ParameterTypeDescription
hWndSalWindowHandle
messageSalNumber
wParamSalNumber
lParamSalString

Returns: SalNumber.

Static memberSetCommonDir(ctrl, index)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
indexSalNumber

Returns: SalString.

Static memberStrChoose(expression, trueValue, falseValue)

sReturn VisStrChoose( expression, TrueValue, FalseValue )

ParameterTypeDescription
expressionSalBoolean
trueValueSalString
falseValueSalString

Returns: SalString.

Static memberStrExpand(template, array)

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

ParameterTypeDescription
templateSalString
arraySalArray

Returns: SalString.

Static memberStrFind(table, key)

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

ParameterTypeDescription
tableSalNumberA handle to the string table (returned by VisStrLoadTable()
keySalStringThe key to look up in the string table

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

Static memberStrFreeTable(table)

Frees string table

ParameterTypeDescription
tableSalNumber

Returns: SalBoolean.

Static memberStrLeftTrim(source)

left trims a string

ParameterTypeDescription
sourceSalString

Returns: SalString.

Static memberStrLoadTable(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

ParameterTypeDescription
fileNameSalStringThe name of the text file to be loaded

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

Static memberStrPad(source, size)

Pads a string

ParameterTypeDescription
sourceSalString
sizeSalNumber

Returns: SalString.

Static memberStrProper(source)

Makes a proper string

ParameterTypeDescription
sourceSalString

Returns: SalString.

Static memberStrRightTrim(source)

Right trims a string

ParameterTypeDescription
sourceSalString

Returns: SalString.

Scans for a string (reverse)

ParameterTypeDescription
sourceSalString
positionSalNumber
searchSalString

Returns: SalNumber.

Static memberStrSubstitute(source, search, replace)

Substitutes Search with Replace in string

ParameterTypeDescription
sourceSalString
searchSalString
replaceSalString

Returns: SalString.

Static memberStrTrim(Source)

Trim a string

ParameterTypeDescription
SourceSalString

Returns: SalString.

Static memberTblAllRows(table, flagsOn, flagsOff)

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

ParameterTypeDescription
tableControl
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

Static memberTblAutoSizeColumn(table, column)

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

ParameterTypeDescription
tableControl
columnControl

Returns: SalBoolean.

Static memberTblClearColumnSelection(table)

Clears column selection

ParameterTypeDescription
tableControl

Returns: SalBoolean.

Static memberTblFindDateTime(table, row, column, date)

Finds a DateTime in the table control.

ParameterTypeDescription
tableControl
rowSalNumber
columnControl
dateSalDateTime

Returns: SalNumber.

Static memberTblFindNumber(table, row, column, number)

Finds a number in the table control.

ParameterTypeDescription
tableControl
rowSalNumber
columnControl
numberSalNumber

Returns: SalNumber.

Static memberTblFindString(table, row, column, pattern)

Finds a string in the table control.

ParameterTypeDescription
tableControl
rowSalNumber
columnControl
patternSalString

Returns: SalNumber.

Static memberTblGetCell(table, row, column)

Retrieves the contents of a cell in a table window.

ParameterTypeDescription
tableControl
rowSalNumber
columnControl

Returns: SalString.

Static memberTblGetColumnTitle(column)

Retrieves the contents of a column heading.

ParameterTypeDescription
columnControl

Returns: SalString.

Static memberTblSetRowColor(table, row, color)

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

ParameterTypeDescription
tableControl
rowSalNumber
colorSalNumber

Returns: SalBoolean.

Static memberTblSetRowPicture(table, rowFlags, picture)

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

ParameterTypeDescription
tableControl
rowFlagsSalNumber
pictureSalNumber

Returns: SalBoolean.

Static memberWaitCursor(Flags)

Turns hourglass cursor on or off.

ParameterTypeDescription
FlagsSalNumber

Returns: SalNumber.

Static memberWinClearAllEditFlags(parent)

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

ParameterTypeDescription
parentControl

Returns: SalNumber.

Static memberWinClearAllFields(parent)

Clears all fields

ParameterTypeDescription
parentControl

Returns: SalNumber.

Static memberWinEnumProps(hWnd, propNames, propValues)

Enumerates windows properties

ParameterTypeDescription
hWndSalWindowHandle
propNamesSalArray<SalString>
propValuesSalArray<SalNumber>

Returns: SalNumber.

Static memberWinFreeAccelerator(accelerator)

Removes the accelerator.

ParameterTypeDescription
acceleratorSalNumber

Returns: SalBoolean.

Static memberWinGetFlags(hWnd)

Gets windows flags

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalNumber.

Static memberWinGetHandle(ctrl, text, type)

Obtains the control of the requested type and text.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
textSalString
typeSalNumber

Returns: SalWindowHandle.

Static memberWinGetProp(hWnd, propName)

Gets a windows property by name

ParameterTypeDescription
hWndSalWindowHandle
propNameSalString

Returns: SalNumber.

Static memberWinGetStyle(hWnd)

Retrieves the Windows style bits for a specified window.

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalNumber.

Static memberWinGetText(ctrl)

Obtains the text of a window.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalString.

Static memberWinIsChild(parent, Child)

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

ParameterTypeDescription
parentSalWindowHandle
ChildSalWindowHandle

Returns: SalBoolean.

Static memberWinIsMaximized(hWnd)

Determines whether a window is maximized.

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalBoolean.

Static memberWinIsMinimized(hWnd)

Determines whether the specified window is minimized (iconic).

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalBoolean.

Static memberWinIsRequiredFieldNull(parent)

Returns the first required field that is empty.

ParameterTypeDescription
parentControl

Returns: SalWindowHandle.

Static memberWinIsRestored(hWnd)

Determines whether the specified window is in the normal state.

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalBoolean.

Static memberWinIsWindow(hWnd)

Determines whether the specified window handle identifies an existing window.

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalBoolean.

Static memberWinLoadAccelerator(target, message, keyState, keyCode, id)

Sets an accelerator keystroke for a window.

ParameterTypeDescription
targetControl
messageSalNumber
keyStateSalNumber
keyCodeSalNumber
idSalNumber

Returns: SalNumber.

Static memberWinMove(hWnd, left, top, width, height)

Moves and resizes a window, based on pixel coordinates.

ParameterTypeDescription
hWndSalWindowHandle
leftSalNumber
topSalNumber
widthSalNumber
heightSalNumber

Returns: SalBoolean.

Static memberWinRemoveProp(hWnd, propName)

Removes windows property

ParameterTypeDescription
hWndSalWindowHandle
propNameSalString

Returns: SalBoolean.

Static memberWinSetFlags(hWnd, winFlags, state)

Set windows flags

ParameterTypeDescription
hWndSalWindowHandle
winFlagsSalNumber
stateSalBoolean

Returns: SalBoolean.

Static memberWinSetMeter(ctrl, percent)

Sets the position of the meter.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
percentSalNumber

Returns: SalNumber.

Static memberWinSetProp(hWnd, propName, propValue)

Set windows property

ParameterTypeDescription
hWndSalWindowHandle
propNameSalString
propValueSalNumber

Returns: SalBoolean.

Static memberWinSetStyle(hWnd, style, state)

Adds/Removes a window style to a window.

ParameterTypeDescription
hWndSalWindowHandle
styleSalNumber
stateSalBoolean

Returns: SalBoolean.

Static memberWinSetTabOrder(ctrl, ctrlAfter)

Changes the tab order of a control.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
ctrlAfterControl

Returns: SalBoolean.

Static memberWinShow(ctrl, showCmd)

Show window

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
showCmdSalNumber

Returns: SalBoolean.