Skip to main content
Version: 2023

Vis

Namespace: PPJ.Runtime.Vis

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

Contains all Vis.* static functions and constants.

public class Vis

Fields

NameTypeDescription
ACTION_AbortInt32
ACTION_RetryInt32Error action codes
CAL_AlternateButtonsInt32*** Styles
CAL_EnableButtonsInt32
CAL_EnableKeyboardInt32
CAL_EtchedLookInt32
CAL_MultiSelectInt32
CAL_SelectExtraInt32
CAL_SelectSpecialInt32
CAL_ShowExtraInt32
CAL_ShowFocusInt32
CAL_ShowGridInt32
CAL_ShowSpecialInt32
CALN_DateChangedInt32
CALN_DateFinishedInt32
CALN_ErrSpaceInt32*** Notification messages
CALN_ScrollInt32
CAPTION_ErrorHandlerString
COLOR_CAL_BackExtraInt32*** Color Roles
COLOR_CAL_BackLabelInt32
COLOR_CAL_ForeDaysInt32
COLOR_CAL_ForeExtraInt32
COLOR_CAL_ForeMonthInt32
COLOR_PAL_BackColorInt32*** Color roles
COLOR_PAL_BackMenuInt32
DAY_FridayInt32
DAY_MondayInt32
DAY_SaturdayInt32
DAY_SundayInt32
DAY_ThursdayInt32
DAY_TuesdayInt32
DAY_UnsetInt32*** Special Rule WeekDays
DAY_WednesdayInt32
DBF_IncrementalTimeInt32Debug flags
DBF_MessageBoxInt32
DBF_RealTimeInt32
DESKTOP_MyComputerInt32
DESKTOP_NetworkNeighborhoodInt32
DESKTOP_RootInt32*** Desktop constants
DOS_BreakFlagInt32
DOS_ErrorModeInt32
DOS_VerifyFlagInt32DOS Flags
DRIVE_CDROMInt32
DRIVE_FixedInt32
DRIVE_FloppyInt32Drive type flags
DRIVE_NetworkInt32
DRIVE_RAMInt32
DROP_ChildInt32Drop Flags
DROP_SiblingInt32
DT_HandleInt32Data Types
EM_SetReadOnlyInt32Edit control messages
FA_VolumeInt32File attribute flags
FILETYPE_DocumentInt32
FILETYPE_OtherInt32
FILETYPE_ProgramInt32File types
FILETYPE_SystemInt32
FONTTYPE_DeviceInt32Font Types
FONTTYPE_RasterInt32
FONTTYPE_TrueTypeInt32
hPicNullInt32General constants
ITEM_CanCollapseUInt32
ITEM_CanDemoteUInt32
ITEM_CanExpandUInt32
ITEM_CanMoveDownUInt32
ITEM_CanMoveUpUInt32
ITEM_CanPromoteUInt32
ITEM_IsDeletedUInt32
ITEM_IsDisabledUInt32List Box Item Flags
ITEM_IsExpandedUInt32
ITEM_IsFocusUInt32
ITEM_IsFrameUInt32
ITEM_IsHiddenUInt32
ITEM_IsParentUInt32
ITEM_IsSelectedUInt32
KDS_AltInt32
KDS_AltCtrlInt32
KDS_AltShiftInt32
KDS_CtrlInt32
KDS_NoneInt32Key Down States
KDS_ShiftInt32
KDS_ShiftAltCtrlInt32
KDS_ShiftCtrlInt32
KS_DownInt32Key state flags
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_VisExtensionsInt32List Box Extended styles
LVA_AlignLeftInt32
LVA_AlignTopInt32
LVA_DefaultInt32*** Arrange Codes (see cListView.Arrange())
LVA_SnapToGridInt32
LVCF_FmtInt32*** Column Masks (see cListView.SetColumn())
LVCF_TextInt32
LVCF_WidthInt32
LVCFMT_CenterInt32
LVCFMT_JustifyMaskInt32
LVCFMT_LeftInt32*** Column Alignments (see cListView.AssignColumns())
LVCFMT_RightInt32
LVFI_NearestXYInt32
LVFI_PartialInt32
LVFI_StringInt32*** FindItem Flags (see cListView.FindItem())
LVFI_WrapInt32
LVHT_AboveInt32
LVHT_BelowInt32
LVHT_NowhereInt32*** HitTest Flags (see cListView.HitTest())
LVHT_OnItemInt32
LVHT_OnItemIconInt32
LVHT_OnItemLabelInt32
LVHT_OnItemStateIconInt32
LVHT_ToLeftInt32
LVHT_ToRightInt32
LVIF_ImageInt32
LVIF_ParamInt32
LVIF_StateInt32
LVIF_TextInt32*** Item Masks (see cListView.SetItem())
LVIR_BoundsInt32*** ItemRect Codes (see cListView.GetItemRect())
LVIR_IconInt32
LVIR_LabelInt32
LVIR_SelectBoundsInt32
LVIS_CutInt32
LVIS_DropHilitedInt32
LVIS_FocusedInt32*** Item States (see cListView.SetItemState())
LVIS_SelectedInt32
LVIS_StateImageMaskInt32
LVN_BeginDragInt32
LVN_BeginRDragInt32
LVN_ColumnClickInt32
LVN_DeleteAllItemsInt32
LVN_DeleteItemInt32
LVN_FirstInt32*** Notification Messages (sent to SAM_CustControlCmd handler)
LVN_InsertItemInt32
LVN_ItemChangedInt32
LVN_ItemChangingInt32
LVNI_AboveInt32
LVNI_AllInt32*** NextItem Flags (see cListView.GetNextItem())
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*** Styles (see cListView.SetStyle())
LVS_ListInt32
LVS_NoColumnHeaderInt32
LVS_NoLabelWrapInt32
LVS_NoScrollInt32
LVS_NoSortHeaderInt32
LVS_ReportInt32
LVS_ShowSelAlwaysInt32
LVS_SingleSelInt32
LVS_SmallIconInt32
LVS_TypeMaskInt32
LVS_TypeStyleMaskInt32
LVSORT_AscendingInt32*** Sort Order Flags (see cListView.SetSortOrder())
LVSORT_DescendingInt32
MBF_IconAsteriskInt32MessageBox constants
MBF_IconErrorInt32
MBF_IconExclamationInt32
MBF_IconHandInt32
MBF_IconInformationInt32
MBF_IconQuestionInt32
MBF_IconStopInt32
MBF_IconWarningInt32
MF_CheckInt32
MF_DisableInt32Menu flags
MF_SeparatorInt32
NM_ClickInt32
NM_DoubleClickInt32
NM_FirstInt32Generic Notification Messages
NM_KillFocusInt32
NM_OutOfMemoryInt32
NM_ReturnInt32
NM_RightClickInt32
NM_RightDoubleClickInt32
NM_SetFocusInt32
ORIENT_SPLIT_HorizontalInt32
ORIENT_SPLIT_UnsetInt32*** Orientation values
ORIENT_SPLIT_VerticalInt32
PAL_EnableMRUColorsInt32*** Styles
PAL_NoHideSelectsInt32
PALETTE_MainInt32
PALETTE_MRUInt32
PALN_ChangedInt32
PALN_ErrSpaceInt32*** Notification messages
PALN_FinishedInt32
PALN_MenuInt32
PIC_LoadFileInt32
PIC_LoadLargeIconInt32
PIC_LoadResourceInt32
PIC_LoadSmallIconInt32
PIC_LoadSWinResInt32
PIC_LoadSWinStrInt32Picture flags (see VisPicLoad())
PicDesktopSalNumber
PicDriveCDSalNumber
PicDriveFixedSalNumber
PicDriveFloppySalNumber
PicDriveNetworkSalNumber
PicDriveRemovableSalNumber
PicFolderClosedSalNumber
PicFolderOpenSalNumber
PicMyComputerSalNumber
PicNetworkNeighborhoodSalNumber
PicTTFontSalNumber
REF_AutoHScrollInt32
REF_AutoVScrollInt32
REF_AutoWordSelectionInt32Option Flags (duplicates of ECO_ constants from Microsoft's RICHEDIT.H)
REF_CFE_AutoColorInt32Character Format Flags (duplicates of CFE_ constants from Microsoft's RICHEDIT.H)
REF_CFE_BoldInt32
REF_CFE_ItalicInt32
REF_CFE_ProtectedInt32
REF_CFE_StrikeoutInt32
REF_CFE_UnderlineInt32
REF_FT_MatchCaseInt32Find Text Flags
REF_FT_WholeWordInt32
REF_NoHideSelInt32
REF_PFA_CenterInt32
REF_PFA_LeftInt32Paragraph Format Alignment Flags (duplicates of PFA_ constants from Microsoft's RICHEDIT.H)
REF_PFA_RightInt32
REF_PFN_BulletInt32Paragraph Format Numbering Flags (duplicates of PFN_ constants from Microsoft's RICHEDIT.H)
REF_ReadOnlyInt32
REF_SaveSelectionInt32
REF_SEL_EmptyInt32Selection Flags (duplicates of SEL_ constants from Microsoft's RICHEDIT.H)
REF_SEL_MultiCharInt32
REF_SEL_MultiObjectInt32
REF_SEL_ObjectInt32
REF_SEL_TextInt32
REF_VerticalInt32
REGION_MainInt32*** Misc. Constants
REGION_MenuInt32
REGION_MRUInt32
REN_ChangeInt32
REN_ErrSpaceInt32Message Types
REN_HScrollInt32
REN_MaxTextInt32
REN_ProtectedInt32
REN_RequestResizeInt32
REN_SelChangeInt32
REN_UpdateInt32
REN_VScrollInt32
ROW_UserFlag1Int32Row flags
ROW_UserFlag2Int32
ROW_UserFlag3Int32
ROW_UserFlag4Int32
ROW_UserFlag5Int32
SEEK_BeginInt32Seek origins
SEEK_CurrentInt32
SEEK_EndInt32
SEQ_FirstInt32
SEQ_FourthInt32
SEQ_LastInt32
SEQ_SecondInt32
SEQ_ThirdInt32
SEQ_UnsetInt32*** Special Day Sequences
SHOW_AllLevelsInt32Show All Levels
SHOW_HiddenInt32Show Window Flags
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_XScreenInt32System metrics constants
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 Flags
SORT_DescendingInt32
SPECIAL_MonthlyDOMInt32
SPECIAL_MonthlyDOWInt32
SPECIAL_OneTimeInt32
SPECIAL_UnsetInt32*** Special Rule Types
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_LeftButtonInt32Virtual keycodes
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_DLLNameStringPicture names (these pictures are in the VT DLL)
VT_EmbeddedResourceString
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_OkInt32Error return values - these are remaps of values found in SDK's WINERROR.H
VTERR_PathNotFoundInt32
VTERR_ReadFaultInt32
VTERR_SharingViolationInt32
VTERR_TooManyFilesInt32
VTERR_WriteFaultInt32
VTERR_WriteProtectedInt32
VTM_AcceleratorInt32
VTM_BaseInt32Messages
VTM_CharInt32
VTM_ClickInt32
VTM_ControlCreateInt32
VTM_CreateInt32Remaps of WM_* messages
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_SpinSetMinInt32Messages
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_TempOnInt32Wait cursor flags
WF_80x87Int32
WF_CPU286Int32
WF_CPU386Int32
WF_CPU486Int32
WF_DisplayOnlyInt32
WF_EnableWhenNotNullInt32
WF_EnhancedInt32
WF_FitPathInt32
WF_NoClearInt32
WF_NoClearEditFlagInt32
WF_PagingInt32
WF_PModeInt32Windows flags
WF_RequiredInt32Window Flags
WF_StandardInt32
WF_WLOInt32

Methods

Static memberArrayAppend(hArySource, hAryTarget, nDataType)

Appends one array to the end of another array.

ParameterTypeDescription
hArySourceSalArray
hAryTargetSalArray
nDataTypeSalNumber

Returns: SalNumber.

Static memberArrayCopy(hArySource, hAryTarget, nDataType)

Copies the source array to the target array.

ParameterTypeDescription
hArySourceSalArray
hAryTargetSalArray
nDataTypeSalNumber

Returns: SalNumber.

Static memberArrayDeleteItem(hArray, nIndex, nDataType)

Deletes an item from an array.

ParameterTypeDescription
hArraySalArray
nIndexSalNumber
nDataTypeSalNumber

Returns: SalNumber.

Static memberArrayFillDateTime(dtArray, dtValue, nCount)

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

ParameterTypeDescription
dtArraySalArray<SalDateTime>
dtValueSalDateTime
nCountSalNumber

Returns: SalBoolean.

Static memberArrayFillNumber(nArray, nValue, nCount)

Fills a Date/Time array with the specified numeric value.

ParameterTypeDescription
nArraySalArray<SalNumber>
nValueSalNumber
nCountSalNumber

Returns: SalBoolean.

Static memberArrayFillString(sArray, sValue, nCount)

Fills a Date/Time array with the specified string value.

ParameterTypeDescription
sArraySalArray<SalString>
sValueSalString
nCountSalNumber

Returns: SalBoolean.

Static memberArrayFindDateTime(hArray, dtSearchFor)

Locates a date/time value within an array.

ParameterTypeDescription
hArraySalArray<SalDateTime>
dtSearchForSalDateTime

Returns: SalNumber.

Static memberArrayFindNumber(hArray, nSearchFor)

Locates a numeric value within an array.

ParameterTypeDescription
hArraySalArray<SalNumber>
nSearchForSalNumber

Returns: SalNumber.

Static memberArrayFindNumber(hArray, bSearchFor)

Locates a numeric value within an array.

ParameterTypeDescription
hArraySalArray<SalBoolean>
bSearchForSalBoolean

Returns: SalNumber.

Static memberArrayFindString(hArray, sSearchFor)

Locates a string value within an array.

ParameterTypeDescription
hArraySalArray<SalString>
sSearchForSalString

Returns: SalNumber.

Static memberArrayInsertItem(hArray, nIndex, nDataType)

nNumItems VisArrayInsertItem( hArray, nIndex, nDataType )

ParameterTypeDescription
hArraySalArray
nIndexSalNumber
nDataTypeSalNumber

Returns: SalNumber.

Static memberArraySort(hArray, nSortOrder, nDataType)

nNumItems VisArraySort( hArray, nSortOrder, nDataType )

ParameterTypeDescription
hArraySalArray
nSortOrderSalNumber
nDataTypeSalNumber

Returns: SalNumber.

Static memberDosBuildFullName(sModuleName, sFileName)

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

ParameterTypeDescription
sModuleNameSalString
sFileNameSalString

Returns: SalString.

Static memberDosEnumDirInfo(sDirSpec, sDirs, dtDateTimes, nAttributes)

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

ParameterTypeDescription
sDirSpecSalString
sDirsSalArray<SalString>
dtDateTimesSalArray<SalDateTime>
nAttributesSalArray<SalNumber>

Returns: SalNumber.

Static memberDosEnumDirs(sDirSpec, sDirs)

Enumerates all the directories using the specified wild card.

ParameterTypeDescription
sDirSpecSalString
sDirsSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumDrives(sDrives)

Enumerates all the logical drives.

ParameterTypeDescription
sDrivesSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumFileInfo(sFileSpec, nAttribute, sFiles, nSizes, dtDateTimes, nAttributes)

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

ParameterTypeDescription
sFileSpecSalString
nAttributeSalNumber
sFilesSalArray<SalString>
nSizesSalArray<SalNumber>
dtDateTimesSalArray<SalDateTime>
nAttributesSalArray<SalNumber>

Returns: SalNumber.

Static memberDosEnumFiles(sFileSpec, nAttributes, sFiles)

Enumerates all the files using the specified wildcard.

ParameterTypeDescription
sFileSpecSalString
nAttributesSalNumber
sFilesSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumNetConnections(sDevices, sNetNames)

Enumerates all the network connections.

ParameterTypeDescription
sDevicesSalArray<SalString>
sNetNamesSalArray<SalString>

Returns: SalNumber.

Static memberDosEnumPath(sDirs)

Enumerates all the paths in the PATH environment variable.

ParameterTypeDescription
sDirsSalArray<SalString>

Returns: SalNumber.

Static memberDosExist(sFileSpec)

Checks if the specified directory exists.

ParameterTypeDescription
sFileSpecSalString

Returns: SalBoolean.

Static memberDosGetCurDir(sDrive)

Returns the current directory.

ParameterTypeDescription
sDriveSalString

Returns: SalString.

Static memberDosGetDriveSize(sDrive, nTotalSpace, nFreeSpace)

ParameterTypeDescription
sDriveSalString
nTotalSpaceSalNumber&
nFreeSpaceSalNumber&

Returns: SalNumber.

Static memberDosGetDriveType(sDrive)

Returns the type of the specified drive.

ParameterTypeDescription
sDriveSalString

Returns: SalNumber.

Static memberDosGetEnvString(sKeyName)

sEnvString VisDosGetEnvString (sKeyName)

ParameterTypeDescription
sKeyNameSalString

Returns: SalString.

Static memberDosGetFlags()

Deprecated memberDeprecated: nFlags VisDosGetFlags ()

Returns: SalNumber.

Static memberDosGetNetName(sDevice)

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

ParameterTypeDescription
sDeviceSalString

Returns: SalString.

Static memberDosGetVersion()

bVersionNumber VisDosGetVersion( )

Returns: SalNumber.

Static memberDosGetVolumeLabel(sDrive)

Returns the volume label of the specified drive.

ParameterTypeDescription
sDriveSalString

Returns: SalString.

Static memberDosIsParent(sDirSpec)

bOk VisDosIsParent (sDirSpec)

ParameterTypeDescription
sDirSpecSalString

Returns: SalBoolean.

Static memberDosMakeAllDir(sDir)

nErrCode VisDosMakeAllDir( sDir )

ParameterTypeDescription
sDirSalString

Returns: SalNumber.

Static memberDosMakePath(sDrive, sDir, sBase, sExt)

sFileSpec VisDosMakePath (sDrive, sDir, sBase, sExt)

ParameterTypeDescription
sDriveSalString
sDirSalString
sBaseSalString
sExtSalString

Returns: SalString.

Static memberDosNetConnect(sDevice, sNetName, sPassword)

Makes a connection to a network resource.

ParameterTypeDescription
sDeviceSalString
sNetNameSalString
sPasswordSalString

Returns: SalNumber.

Static memberDosNetDisconnect(sDevice, bForce)

nErrCode VisDosNetDisconnect( sDevice, bForce )

ParameterTypeDescription
sDeviceSalString
bForceSalBoolean

Returns: SalNumber.

Static memberDosSetFlags(nFlags, bState)

Deprecated memberDeprecated: Not supported.

ParameterTypeDescription
nFlagsSalNumber
bStateSalBoolean

Returns: SalNumber.

Static memberDosSetVolumeLabel(sDrive, sLabel)

Sets the label of a file system volume.

ParameterTypeDescription
sDriveSalString
sLabelSalString

Returns: SalNumber.

Static memberDosSplitPath(sFileSpec, sDrive, sDir, sBase, sExt)

ParameterTypeDescription
sFileSpecSalString
sDriveSalString&
sDirSalString&
sBaseSalString&
sExtSalString&

Returns: SalNumber.

Static memberErrorRecovery(sCaption)

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

ParameterTypeDescription
sCaptionSalString

Returns: SalNumber.

Static memberFileAppend(sSourceFile, sTargetFile)

File functions nErrCode VisFileAppend( sSourceFile, sTargetFile )

ParameterTypeDescription
sSourceFileSalString
sTargetFileSalString

Returns: SalNumber.

Static memberFileClose(hFile)

nErrCode VisFileClose( hFile )

ParameterTypeDescription
hFileSalFileHandle

Returns: SalNumber.

Static memberFileCopy(sSourceFile, sTargetFile)

nErrCode VisFileCopy( sSourceFile, sTargetFile )

ParameterTypeDescription
sSourceFileSalString
sTargetFileSalString

Returns: SalNumber.

Static memberFileCreateTemp(sPrefix)

sTempName VisDosGetTempFileName( sPrefix )

ParameterTypeDescription
sPrefixSalString

Returns: SalString.

Static memberFileDelete(sFileName)

nNumDeleted VisFileDelete( sFileName )

ParameterTypeDescription
sFileNameSalString

Returns: SalNumber.

Static memberFileExpand(sSourceFile, sTargetFile)

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

ParameterTypeDescription
sSourceFileSalString
sTargetFileSalString

Returns: SalNumber.

Static memberFileFind(sFileName)

SalString VisFileFind (sFileName)

ParameterTypeDescription
sFileNameSalString

Returns: SalString.

Static memberFileGetAttribute(sFileName)

nAttribute VisFileGetAttribute( sFileName )

ParameterTypeDescription
sFileNameSalString

Returns: SalNumber.

Static memberFileGetSize(sFileName)

nFileSize VisFileGetSize( sFileName )

ParameterTypeDescription
sFileNameSalString

Returns: SalNumber.

Static memberFileGetType(sFileName)

nFileType VisFileGetType( sFileName )

ParameterTypeDescription
sFileNameSalString

Returns: SalNumber.

Static memberFileOpen(hFile, sFileName, nFlags)

ParameterTypeDescription
hFileSalFileHandle&
sFileNameSalString
nFlagsSalNumber

Returns: SalNumber.

Static memberFileRead(hFile, sBuffer, nSize)

ParameterTypeDescription
hFileSalFileHandle
sBufferSalString&
nSizeSalNumber

Returns: SalNumber.

Static memberFileReadString(hFile, sLine)

ParameterTypeDescription
hFileSalFileHandle
sLineSalString&

Returns: SalNumber.

Static memberFileRename(sSourceFile, sTargetFile)

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
sSourceFileSalString
sTargetFileSalString

Returns: SalNumber.

Static memberFileSeek(hFile, nOffset, nOrigin)

nErrCode VisFileSeek( hFile, nOffset, nOrigin )

ParameterTypeDescription
hFileSalFileHandle
nOffsetSalNumber
nOriginSalNumber

Returns: SalNumber.

Static memberFileSetAttribute(sFileName, nAttributes, bState)

nErrCode VisFileSetAttribute( sFileName, nAttributes, bState )

ParameterTypeDescription
sFileNameSalString
nAttributesSalNumber
bStateSalBoolean

Returns: SalNumber.

Static memberFileSetDateTime(sFileName, dtDateTime)

nErrCode VisFileSetDateTime( sFileName, dtDateTime )

ParameterTypeDescription
sFileNameSalString
dtDateTimeSalDateTime

Returns: SalNumber.

Static memberFileTell(hFile)

nOffset VisFileTell( hFile )

ParameterTypeDescription
hFileSalFileHandle

Returns: SalNumber.

Static memberFileWrite(hFile, sBuffer, nSize)

nErrCode VisFileWrite( hFile, sBuffer, nSize )

ParameterTypeDescription
hFileSalFileHandle
sBufferSalString
nSizeSalNumber

Returns: SalNumber.

Static memberFileWriteString(hFile, sLine)

nErrCode VisFileWriteString( hFile, sLine )

ParameterTypeDescription
hFileSalFileHandle
sLineSalString

Returns: SalNumber.

Static memberFontEnum(nType, sNames, nTypes)

Enumerates all the installed fonts.

ParameterTypeDescription
nTypeSalNumber
sNamesSalArray<SalString>
nTypesSalArray<SalNumber>

Returns: SalNumber.

Static memberFontFree(hFont)

Release the font handle.

ParameterTypeDescription
hFontSalNumber

Returns: SalBoolean.

Static memberFontGet(hFont, sFaceName, nPointSize, nFontFlags)

ParameterTypeDescription
hFontSalNumber
sFaceNameSalString&
nPointSizeSalNumber&
nFontFlagsSalNumber&

Returns: SalBoolean.

Static memberFontLoad(sFaceName, nPointSize, nEnhFlags)

Loads the specified font.

ParameterTypeDescription
sFaceNameSalString
nPointSizeSalNumber
nEnhFlagsSalNumber

Returns: SalNumber.

Static memberGetCommonDir(ctrl, nIndex)

Retrieves the current directory of a common dialog listbox or combobox.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalString.

Static memberGetCopyright()

Retrieves a copyright string.

Returns: SalString.

Static memberGetKeyState(virtKey)

Retrieves the state of a specified key.

ParameterTypeDescription
virtKeySalNumberVirtual key code to check.

Returns: SalNumber. The return value specifies the status of the specified virtual key, as follows: If the high-order bit is 1, the key is down; otherwise, it is up. If the low-order bit is 1, the key is toggled.A key, such as the CAPS LOCK key, is toggled if it is turned on. The key is off and untoggled if the low-order bit is 0.

Static memberGetVersion()

sVersion VisGetVersion( )

Returns: SalString.

Static memberGetWinVersion()

nVersion VisGetWinVersion( )

Returns: SalNumber.

Static memberListAddColor(ctrl, sText, nColor)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sTextSalString
nColorSalNumber

Returns: SalNumber.

Static memberListAddColorValue(ctrl, sText, nColor, nValue)

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.
sTextSalString
nColorSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListAddFont(ctrl, sText, hFont)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sTextSalString
hFontSalNumber

Returns: SalNumber.

Static memberListAddFontValue(ctrl, sText, hFont, nValue)

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.
sTextSalString
hFontSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListAddPicture(ctrl, sText, hPicNormal, hPicSelected)

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.
sTextSalString
hPicNormalSalNumber
hPicSelectedSalNumber

Returns: SalNumber.

Static memberListAddPictureValue(ctrl, sText, hPicNormal, hPicSelected, nValue)

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.
sTextSalString
hPicNormalSalNumber
hPicSelectedSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListAddValue(ctrl, sText, nValue)

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

ParameterTypeDescription
ctrlControl
sTextSalString
nValueSalNumber

Returns: SalNumber.

Static memberListArrayPopulate(ctrl, sTexts)

Populates a list box from a string array.

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

Returns: SalNumber.

Static memberListArrayPopulateValue(ctrl, sTexts, nValues)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sTextsSalArray<SalString>
nValuesSalArray<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, nIndex)

Collapses all descendant items.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalBoolean.

Static memberListDeleteChild(ctrl, nIndex)

Deletes the child item from the tree control.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListDeleteDescendents(ctrl, nIndex)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListDeleteSelected(ctrl)

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

ParameterTypeDescription
ctrlControl

Returns: SalNumber.

Static memberListDemote(ctrl, nIndex, hPicNormal, hPicSelect)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Static memberListDisableItem(ctrl, nIndex, nColor)

ParameterTypeDescription
ctrlControl
nIndexSalNumber
nColorSalNumber

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, nIndex, nColor)

Enables the specified item and sets the specified color.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
nColorSalNumber

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)

ParameterTypeDescription
itemSalNumber
valueSalNumber

Returns: SalNumber.

Static memberListFindString(ctrl, nStartIndex, sText)

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
ctrlControl
nStartIndexSalNumber
sTextSalString

Returns: SalNumber.

Static memberListFindValue(ctrl, nStartIndex, nValue)

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.
nStartIndexSalNumber
nValueSalNumber

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, nIndex)

Returns the current color of the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

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, nIndex)

Returns the ITEM_* flags for the specified list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

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
ctrlControl

Returns: SalNumber.

Static memberListGetFont(ctrl, nIndex)

Returns the current font of the list control item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListGetItemColor(item)

Retrieves the color associated with an outline item.

ParameterTypeDescription
itemSalNumber

Returns: SalNumber.

Static memberListGetItemData(item, sText, nValue, nItemFlags)

ParameterTypeDescription
itemSalNumber
sTextSalString&
nValueSalNumber&
nItemFlagsSalNumber&

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, hPicNormal, hPicSelect)

ParameterTypeDescription
itemSalNumber
hPicNormalSalNumber&
hPicSelectSalNumber&

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, nIndex, hPicNormal, hPicSelected)

ParameterTypeDescription
ctrlControl
nIndexSalNumber
hPicNormalSalNumber&
hPicSelectedSalNumber&

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, nIndex)

Returns the text of the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalString.

Static memberListGetValue(ctrl, nIndex)

Returns the value associated to the list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListInsertColor(ctrl, nIndex, sText, nColor)

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.
nIndexSalNumber
sTextSalString
nColorSalNumber

Returns: SalNumber.

Static memberListInsertColorValue(ctrl, nIndex, sText, nColor, nValue)

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.
nIndexSalNumber
sTextSalString
nColorSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListInsertFont(ctrl, nIndex, sText, hFont)

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.
nIndexSalNumber
sTextSalString
hFontSalNumber

Returns: SalNumber.

Static memberListInsertFontValue(ctrl, nIndex, sText, hFont, nValue)

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.
nIndexSalNumber
sTextSalString
hFontSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListInsertPicture(ctrl, nIndex, sText, hPicNormal, hPicSelected)

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.
nIndexSalNumber
sTextSalString
hPicNormalSalNumber
hPicSelectedSalNumber

Returns: SalNumber.

Static memberListInsertPictureValue(ctrl, nIndex, sText, hPicNormal, hPicSelected, nValue)

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.
nIndexSalNumber
sTextSalString
hPicNormalSalNumber
hPicSelectedSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListInsertValue(ctrl, nIndex, sText, nValue)

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.
nIndexSalNumber
sTextSalString
nValueSalNumber

Returns: SalNumber.

Static memberListIsMultiSelect(ctrl)

Returns true if the listbox is multiselect.

ParameterTypeDescription
ctrlControl

Returns: SalBoolean.

Static memberListLoadChild(ctrl, hItemParent, hPicNormal, hPicSelect, sText, nValue, nItemFlags)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hItemParentSalNumber
hPicNormalSalNumber
hPicSelectSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Static memberListLoadChildren(ctrl, hItemParent, hPicNormal, hPicSelected, sTexts, nValues, nItemFlags)

hItem VisListLoadChildren( hWnd, hItemParent, hPicNormal, hPicSelect, sText[], nValue[], nItemFlags[*] )

ParameterTypeDescription
ctrlControl
hItemParentSalNumber
hPicNormalSalNumber
hPicSelectedSalNumber
sTextsSalArray<SalString>
nValuesSalArray<SalNumber>
nItemFlagsSalArray<SalNumber>

Returns: SalNumber.

Static memberListLoadOutline(ctrl, sBlob)

hItem VisListLoadOutline( hWnd, sBlob )

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sBlobSalString

Returns: SalNumber.

Static memberListLoadOutlineFile(ctrl, sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect)

hItem VisListLoadOutlineFile( hWnd, sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect )

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sFileNameSalString
hPicParentNormalSalNumber
hPicParentSelectSalNumber
hPicChildNormalSalNumber
hPicChildSelectSalNumber

Returns: SalNumber.

Static memberListLoadSibling(ctrl, hItemBefore, hPicNormal, hPicSelect, sText, nValue, nItemFlags)

hItem VisListLoadSibling( hWnd, hItemBefore, hPicNormal, hPicSelect, sText, nValue, nItemFlags )

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hItemBeforeSalNumber
hPicNormalSalNumber
hPicSelectSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Static memberListMoveDown(ctrl, nIndex)

bOk VisListMoveDown( hWnd, nIndex )

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalBoolean.

Static memberListMoveUp(ctrl, nIndex)

bOk VisListMoveUp( hWnd, nIndex )

ParameterTypeDescription
ctrlControl
nIndexSalNumber

Returns: SalBoolean.

Static memberListPromote(ctrl, nIndex, hPicNormal, hPicSelect)

bOk VisListPromote( hWnd, nIndex, hpicNormal, hpicSelect )

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Static memberListSaveOutline(ctrl, sBlob)

ParameterTypeDescription
ctrlControl
sBlobSalString&

Returns: SalNumber.

Static memberListScroll(ctrl, nIndex)

Scrolls an item into view.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListSetColor(ctrl, nIndex, nColor)

Sets the color of a list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
nColorSalNumber

Returns: SalBoolean.

Static memberListSetDropdownState(ctrl, bState)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
bStateSalBoolean

Returns: SalBoolean.

Static memberListSetFlags(ctrl, nIndex, nItemFlags, bState)

Sets the ITEM_* flags for the specified list item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
nItemFlagsSalNumber
bStateSalBoolean

Returns: SalNumber.

Static memberListSetFocusIndex(ctrl, nIndex)

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.
nIndexSalNumber

Returns: SalNumber.

Static memberListSetFont(ctrl, nIndex, hFont)

Sets the font of the list control item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
hFontSalNumber

Returns: SalBoolean.

Static memberListSetItemColor(item, nColor)

Sets the color of the outline item.

ParameterTypeDescription
itemSalNumber
nColorSalNumber

Returns: SalBoolean.

Static memberListSetItemData(ctrl, item, sText, nValue, nItemFlags)

Updates the specified item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
itemSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Static memberListSetItemFlags(item, nItemFlags, bState)

bOk VisListSetItemFlags( item, nItemFlags, bState )

ParameterTypeDescription
itemSalNumber
nItemFlagsSalNumber
bStateSalBoolean

Returns: SalBoolean.

Static memberListSetItemFont(item, hFont)

Sets the font of the outline item.

ParameterTypeDescription
itemSalNumber
hFontSalNumber

Returns: SalBoolean.

Static memberListSetItemPicture(item, hPicNormal, hPicSelect)

Sets the picture of a list item

ParameterTypeDescription
itemSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Static memberListSetItemText(item, sText)

Sets the text of the outline item.

ParameterTypeDescription
itemSalNumber
sTextSalString

Returns: SalBoolean.

Static memberListSetItemValue(item, nValue)

Sets the value associated to the outline item.

ParameterTypeDescription
itemSalNumber
nValueSalNumber

Returns: SalBoolean.

Static memberListSetOutlineRedraw(ctrl, bRedraw)

bOk VisListSetOutlineRedraw

ParameterTypeDescription
ctrlControl
bRedrawSalBoolean

Returns: SalBoolean.

Static memberListSetPicture(ctrl, nIndex, hPicNormal, hPicSelected)

Changes the normal and selected images for the specified item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
hPicNormalSalNumber
hPicSelectedSalNumber

Returns: SalBoolean.

Static memberListSetScrollWidth(ctrl, nIndex)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalNumber.

Static memberListSetStyle(ctrl, nStyle, lParam)

Sets the LBS_* style of the specified control.

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

Returns: SalBoolean.

Static memberListSetText(ctrl, nIndex, sText)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
sTextSalString

Returns: SalNumber.

Static memberListSetValue(ctrl, nIndex, nValue)

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber
nValueSalNumber

Returns: SalNumber.

Static memberListShowOutline(ctrl, nLevel)

Expands list items up to the specified level.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nLevelSalNumber

Returns: SalBoolean.

Checks the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

Removes the menu at the requested position.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

Disables the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

Enables the menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

Returns the number of items in the specified menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber

Returns: SalNumber.

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

ParameterTypeDescription
ctrlControl

Returns: SalNumber.

Retrieves the menu handle of a pop-up menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalNumber.

Deprecated memberDeprecated: Not supported.

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalNumber.

Retrieves the text of a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalString.

Inserts a menu item into a menu.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber
sTextSalString
nFlagsSalNumber

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.
hMenuSalNumber
nPosSalNumber
hFontSalNumber
sTextSalString

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.
hMenuSalNumber
nPosSalNumber
hPicNormalSalNumber
hPicSelectedSalNumber
sTextSalString

Returns: SalNumber.

Returns true if the menu is checked.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

Returns true if the menu is enabled.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber
hFontSalNumber
sTextSalString

Returns: SalBoolean.

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

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber
hPicNormalSalNumber
hPicSelectedSalNumber
sTextSalString

Returns: SalBoolean.

Changes the text of a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber
sTextSalString

Returns: SalBoolean.

Unchecks a menu item.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
hMenuSalNumber
nPosSalNumber

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(hBtn)

Frees the previously created MessageBox button.

ParameterTypeDescription
hBtnSalNumberHandle of the MessageBox button to free.

Returns: SalBoolean.

Static memberMessageLoadButton(sLabel, nReturn)

Creates a button to be used in the MessageBox.

ParameterTypeDescription
sLabelSalStringText of the MessageBox button.
nReturnSalNumberID of the MessageBox button returned by MessageBox.

Returns: SalNumber.

Static memberNumberBitClear(nValue, nBitMask)

ParameterTypeDescription
nValueSalNumber&
nBitMaskSalNumber

Returns: SalNumber.

Static memberNumberBitSet(nValue, nBitMask)

ParameterTypeDescription
nValueSalNumber&
nBitMaskSalNumber

Returns: SalNumber.

Static memberNumberChoose(bExpression, nTrue, nFalse)

nReturn VisNumberChoose( bExpression, nTrue, nFalse )

ParameterTypeDescription
bExpressionSalBoolean
nTrueSalNumber
nFalseSalNumber

Returns: SalNumber.

Static memberNumberHighByte(nNumber)

nHighByte VisNumberHighByte( nNumber )

ParameterTypeDescription
nNumberSalNumber

Returns: SalNumber.

Static memberNumberLowByte(nNumber)

nLowByte VisNumberLowByte( nNumber )

ParameterTypeDescription
nNumberSalNumber

Returns: SalNumber.

Static memberNumberMakeLong(nLowWord, nHighWord)

nLong VisNumberMakeLong( nLowWord, nHighWord )

ParameterTypeDescription
nLowWordSalNumber
nHighWordSalNumber

Returns: SalNumber.

Static memberPicFree(hPic)

Removes a picture and frees it's memory.

ParameterTypeDescription
hPicSalNumber

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, sDirectory)

Adds all directories to a listbox or combobox.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sDirectorySalString

Returns: SalNumber.

Static memberPopulateDirTree(ctrl, sDirectory)

Populates the tree control with the specified directories.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
sDirectorySalString

Returns: SalNumber.

Static memberPopulateDrives(ctrl)

Adds all available drives to a listbox or combobox.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.

Returns: SalNumber.

Static memberPopulateFontNames(ctrl, nType)

Populates the control with the names of all the fonts.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nTypeSalNumber

Returns: SalNumber.

Static memberProfileDelete(sFileName, sSection, sEntry)

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

ParameterTypeDescription
sFileNameSalString
sSectionSalString
sEntrySalString

Returns: SalBoolean.

Static memberProfileEnumStrings(sFileName, sSection, sStrings)

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

ParameterTypeDescription
sFileNameSalString
sSectionSalString
sStringsSalArray<SalString>

Returns: SalNumber.

Static memberSetCommonDir(ctrl, nIndex)

Changes the current directory of a common dialog listbox or combobox.

ParameterTypeDescription
ctrlControlTarget control on which to execute the call.
nIndexSalNumber

Returns: SalString.

Static memberStrChoose(bExpression, sTrue, sFalse)

sReturn VisStrChoose( bExpression, sTrue, sFalse )

ParameterTypeDescription
bExpressionSalBoolean
sTrueSalString
sFalseSalString

Returns: SalString.

Static memberStrExpand(sTemplate, hArray)

sReturn VisStrExpand( sTemplate, hArray )

ParameterTypeDescription
sTemplateSalString
hArraySalArray

Returns: SalString.

Static memberStrFind(hTable, sKey)

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

ParameterTypeDescription
hTableSalNumberA handle to the string table (returned by VisStrLoadTable()
sKeySalStringThe key to look up in the string table

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

Static memberStrFreeTable(hTable)

bOk VisStrFreeTable( hTable )

ParameterTypeDescription
hTableSalNumber

Returns: SalBoolean.

Static memberStrLeftTrim(sSource)

sReturn VisStrLeftTrim( sSource )

ParameterTypeDescription
sSourceSalString

Returns: SalString.

Static memberStrLoadTable(sFilename)

VisStrLoadTable loads the lines from a text file and returns a handle to it.

ParameterTypeDescription
sFilenameSalStringThe name of the text file to be loaded

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

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

Static memberStrPad(sSource, nSize)

sReturn VisStrPad( sSource, nSize )

ParameterTypeDescription
sSourceSalString
nSizeSalNumber

Returns: SalString.

Static memberStrProper(sSource)

sReturn VisStrProper( sSource )

ParameterTypeDescription
sSourceSalString

Returns: SalString.

Static memberStrRightTrim(sSource)

sReturn VisStrRightTrim( sSource )

ParameterTypeDescription
sSourceSalString

Returns: SalString.

Static memberStrScanReverse(sSource, nPos, sSearch)

nPos VisStrScanReverse( sSource, nPos, sSearch )

ParameterTypeDescription
sSourceSalString
nPosSalNumber
sSearchSalString

Returns: SalNumber.

Static memberStrSubstitute(sSource, sSearch, sReplace)

sReturn VisStrSubstitute( sSource, sSearch, sReplace )

ParameterTypeDescription
sSourceSalString
sSearchSalString
sReplaceSalString

Returns: SalString.

Static memberStrTrim(sSource)

sReturn VisStrTrim( sSource )

ParameterTypeDescription
sSourceSalString

Returns: SalString.

Static memberTblAllRows(table, nFlagsOn, nFlagsOff)

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

ParameterTypeDescription
tableControl
nFlagsOnSalNumber
nFlagsOffSalNumber

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)

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, nRow, column)

Retrieves the contents of a cell in a table window.

ParameterTypeDescription
tableControl
nRowSalNumber
columnControl

Returns: SalString.

Static memberTblGetColumnTitle(column)

Retrieves the contents of a column heading.

ParameterTypeDescription
columnControl

Returns: SalString.

Static memberTblSetRowColor(table, nRow, nColor)

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

ParameterTypeDescription
tableControl
nRowSalNumber
nColorSalNumber

Returns: SalBoolean.

Static memberTblSetRowPicture(table, rowFlags, handle)

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

ParameterTypeDescription
tableControlThe table window control to assign the custom image to.
rowFlagsSalNumberRow flags that enable the specified image.
handleSalNumberThe image handle to assign to the combination of row flags.

Returns: SalBoolean.

Static memberTblSetRowPicture(table, rowFlags, image)

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

ParameterTypeDescription
tableControlThe table window control to assign the custom image to.
rowFlagsSalNumberRow flags that enable the specified image.
imageImageThe image to assign to the combination of row flags.

Returns: SalBoolean.

Static memberTblSetRowPicture(table, rowFlags, imageSource)

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

ParameterTypeDescription
tableControlThe table window control to assign the custom image to.
rowFlagsSalNumberRow flags that enable the specified image.
imageSourceStringThe image source to assign to the combination of row flags.

Returns: SalBoolean.

Static memberWaitCursor(nFlags)

Turns hourglass cursor on or off.

ParameterTypeDescription
nFlagsSalNumber

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)

nNumCleared VisWinClearAllFields( hWndParent )

ParameterTypeDescription
parentControl

Returns: SalNumber.

Static memberWinFreeAccelerator(hAccel)

Removes the accelerator.

ParameterTypeDescription
hAccelSalNumber

Returns: SalBoolean.

Static memberWinGetFlags(hWnd)

Gets windows flags

ParameterTypeDescription
hWndSalWindowHandle

Returns: SalNumber.

Static memberWinGetHandle(ctrl, sText, nType)

Obtains the control of the requested type and text.

ParameterTypeDescription
ctrlControl
sTextSalString
nTypeSalNumber

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(hWndParent, hWndChild)

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

ParameterTypeDescription
hWndParentSalWindowHandle
hWndChildSalWindowHandle

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, nMessage, nKeyState, nKey, nID)

Sets an accelerator keystroke for a window.

ParameterTypeDescription
targetControl
nMessageSalNumber
nKeyStateSalNumber
nKeySalNumber
nIDSalNumber

Returns: SalNumber.

Static memberWinMove(hWnd, nLeft, nTop, nWidht, nHeight)

Moves and resizes a window, based on pixel coordinates.

ParameterTypeDescription
hWndSalWindowHandle
nLeftSalNumber
nTopSalNumber
nWidhtSalNumber
nHeightSalNumber

Returns: SalBoolean.

Static memberWinSetFlags(hWnd, winFlags, state)

Set windows flags

ParameterTypeDescription
hWndSalWindowHandle
winFlagsSalNumber
stateSalBoolean

Returns: SalBoolean.

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, nShowCmd)

bOk VisWinShow( hWnd, nShowCmd )

ParameterTypeDescription
ctrlControl
nShowCmdSalNumber

Returns: SalBoolean.