XSal

PPJ.Runtime.XSal.XSal

Namespace: PPJ.Runtime.XSal

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

XSal functions.

public class XSal

Fields

Name
Type
Description

SAM_DrawCell

Callback message for cell drawing The table window receives this message each time a custom drawn cell needs to be repainted. wParam = cell selected flag (TRUE or FALSE) lParam = pointer to a structure with drawing information. Use it with XSalTblGetCustomInfo().

SAM_HotSpotClick

The form, dialog or MDI receive this message when the user clicks the left mouse button on the hot spot. wParam = HotSpot ID lParam = Mouse position

SAM_HotSpotMouseMove

The form, dialog or MDI receive this message when the user moves the mouse on the hot spot. wParam = HotSpot ID if the mouse is entering the hot spot or NULL if the mouse is leaving the hot spot. lParam = Mouse position

SAM_SwapRows

Notification message from XSalTblSortRows. The table window receives this message each time the quick-sort routine swaps two rows. wParam = first row lParam = second row

SAM_ToolboxSetPosition

The toolbox receives this message when it's orientation and position are being changed. This allows the program to change some visual aspect of the toolbox. wParam = The new orientation flag lParam = not used

SAM_ToolboxUpdateMenu

Send to the form that owns the tool bars. The app can modify the popup menu before it's displayed by processing this event. The menu object can be accessed using the form's ContextMenu property or VT menu functions using wParam for the menu handle. wParam = Handle for the menu lParam = not used.

SAM_TooltipClose

Sent to the control with the tool tip when the tool tip is destroyed.

SAM_TooltipSetText

Sent to the control under the mouse to show the tool tip.

Properties

ToolTip

ToolTip: Returns the single tool tips instance used by XSalTooltips.

Methods

BitmapClose(hBitmap)

Frees the bitmap handle.

Parameter
Type
Description

hBitmap

Returns: SalBoolean.

BitmapCreateDisabled(Param1, Param2)

HBITMAP XSalBitmapCreateDisabled( HBITMAP p_hBitmap, COLORREF p_cColor );

Parameter
Type
Description

Param1

Param2

Returns: SalNumber.

BitmapDraw(ctrl, hImage, x, y, width, height)

Draws the image inside the control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

hImage

height

Returns: SalBoolean.

BitmapDraw(ctrl, hImage, x, y, width, height, transparent)

Draws the image inside the control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

hImage

height

transparent

Returns: SalBoolean.

BitmapDrawDC(Param1, Param2, Param3, Param4, Param5, Param6)

Draws the image inside the device context.

Parameter
Type
Description

Param1

Param2

Param3

Param4

Param5

Param6

Returns: SalBoolean.

BitmapFromFile(fileName)

Returns the bitmap handle from the image file.

Parameter
Type
Description

fileName

Returns: SalNumber.

BitmapFromIcon(Param1, Param2)

HBITMAP XSalBitmapFromIcon( HICON p_hIcon, COLORREF p_cBackColor );

Parameter
Type
Description

Param1

Param2

Returns: SalNumber.

BitmapFromResource(resName)

Returns the bitmap handle from the resource object,

Parameter
Type
Description

resName

Returns: SalNumber.

BitmapFromString(bitmapBytes)

Returns the bitmap handle from the bytes string.

Parameter
Type
Description

bitmapBytes

Returns: SalNumber.

BitmapFromWindow(Param1, Param2)

HBITMAP XSalBitmapFromWindow( HWND p_hWnd, BOOL p_bClientOnly )

Parameter
Type
Description

Returns: SalNumber.

BitmapToString(Param1, Param2)

Parameter
Type
Description

Returns: SalBoolean.

GetClientWindow(form)

Returns the client area of a form with the accessories enabled.

Parameter
Type
Description

Returns: SalWindowHandle.

GetWindowHotSpot(ctrl, id, x, y, width, height)

Parameter
Type
Description

Returns: SalBoolean.

GetWindowImage(ctrl, hImage)

Parameter
Type
Description

Returns: SalBoolean.

GZipClose(Param1)

Parameter
Type
Description

Returns: SalBoolean.

GZipEof(Param1)

BOOL XSalGZipEof( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipFlush(Param1)

BOOL XSalGZipFlush( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipGetChar(Param1)

CHAR XSalGZipGetStr( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalNumber.

GZipGetError(Param1, Param2)

Parameter
Type
Description

Returns: SalString.

GZipGetStr(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalNumber.

GZipOpen(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalBoolean.

GZipPutChar(Param1, Param2)

BOOL XSalGZipPutChar( gzFile p_File, CHAR p_cChar )

Parameter
Type
Description

Returns: SalBoolean.

GZipPutStr(Param1, Param2)

INT XSalGZipPutStr( gzFile p_File, LPSTR p_lpBufferOut )

Parameter
Type
Description

Param1

Param2

Returns: SalNumber.

GZipRead(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalNumber.

GZipRewind(Param1)

BOOL XSalGZipRewind( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipSeek(Param1, Param2, Param3)

LONG XSalGZipSeek( gzFile p_File, LONG p_lOffset, INT p_iWhence )

Parameter
Type
Description

Param1

Param2

Param3

Returns: SalNumber.

GZipTell(Param1)

LONG XSalGZipTell( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalNumber.

GZipWrite(Param1, Param2, Param3)

LONG XSalGZipWrite( gzFile p_File, LPVOID p_lpBufferOut, LONG p_lSize )

Parameter
Type
Description

Param1

Param2

Param3

Returns: SalNumber.

ScriptAddLine(handle, line)

Adds a line to the script and recompiles.

Parameter
Type
Description

Returns: SalBoolean.

ScriptCreate(source)

Creates and compiles the script.

Parameter
Type
Description

source

Returns: SalNumber.

ScriptFree(handle)

Frees the script.

Parameter
Type
Description

handle

Returns: SalBoolean.

ScriptGetErrors(handle, errorsList)

Parameter
Type
Description

handle

errorsList

Returns: SalNumber.

ScriptGetLocalName(handle, localName, varName)

Deprecated: Not supported.

Parameter
Type
Description

handle

localName

varName

Returns: SalBoolean.

ScriptRun(handle, result)

Parameter
Type
Description

Returns: SalBoolean.

ScriptSetContext(handle, context)

Changes the execution context for the script object.

Parameter
Type
Description

handle

context

Returns: SalBoolean.

ScriptSetDebugMode(handle, debugOn)

Enables/Disables debug mode. When the debug mode is on, the exceptions generated by the interpreter are unhandled.

Parameter
Type
Description

handle

debugOn

Returns: SalBoolean.

ScriptSetTimeout(handle, timeout)

Deprecated: Not supported. Not supported.

Parameter
Type
Description

handle

timeout

Returns: SalBoolean.

SetWindowHotSpot(ctrl, id, x, y, width, height)

Creates a new hot spot are on the windows background. If the hot spot dimensions are 0,0,0,0 the specified hot spot ID is removed.

Parameter
Type
Description

ctrl

The control to add the hot spot to.

id

A unique id returned in the SAM_HotSpotClick event.

x

The X coordinate of the hot spot in pixels.

y

The X coordinate of the hot spot in pixels.

width

The width of the hot spot in pixels.

height

The height of the hot spot in pixels.

Returns: SalBoolean.

SetWindowImage(ctrl, hImage, flags)

Sets the image to show as the background of the specified window.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

hImage

Returns: SalBoolean.

SetWindowImageFile(ctrl, sFileName, flags)

Sets the image to show as the background of the specified window.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

sFileName

Returns: SalBoolean.

SplitGetBarPosition(split)

Returns the position of the splitter. If the splitter is proportional, the position is expressed as a percentage integer: 500 = 50%.

Parameter
Type
Description

Returns: SalNumber.

SplitGetFrameChild(split, frame)

Returns the child control associated to the splitter's frames.

Parameter
Type
Description

Returns: SalWindowHandle.

SplitGetStyle(split)

Returns the styles of the splitter.

Parameter
Type
Description

Returns: SplitterStyles.

SplitSetBarPosition(split, pos)

Sets the position of the splitter. If the splitter is proportional, the position is expressed as a percentage integer: 500 = 50%.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetBarSize(split, size)

Sets the size of the splitter.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetFrameChild(split, child, frame)

Associates the child control to the splitter's frames.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetMinMax(split, min, max)

Sets the minimum and maximum positions for the splitter.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetStyle(split, style, on)

Sets the style of the splitter.

Parameter
Type
Description

Returns: SalBoolean.

StrAny(text, chars)

Finds the first character in the string that appears in a given character set.

Parameter
Type
Description

Returns: SalNumber.

StrCompare(source, compare, start, size, caseSensitive)

Compares a substring in a string.

Parameter
Type
Description

source

compare

caseSensitive

Returns: SalBoolean.

StrCompress(inString, level, outString)

Parameter
Type
Description

inString

outString

Returns: SalBoolean.

StrCount(text, search, start, length, left)

Counts the number of times a substring appears in a string.

Parameter
Type
Description

Returns: SalNumber.

StrFit(ctrl, text, append)

Truncates the string to fit the control's width and adds the ellipses characters at the end of the resulting string.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

append

Returns: SalString.

StrFormat(text, mask)

Formats a string using a string mask.

Parameter
Type
Description

Returns: SalString.

StrFormatDateTime(date, format, language)

Parameter
Type
Description

Returns: SalString.

StrFormatDateTimeX(date, format, days, shortDays, months, shortMonths)

Parameter
Type
Description

format

shortDays

months

shortMonths

Returns: SalString.

StrFromHex(hex)

Converts a hexadecimal text into a string.

Parameter
Type
Description

Returns: SalString.

StrGetCharAt(text, index)

Returns the character at the indicated position.

Parameter
Type
Description

Returns: SalNumber.

StrGetFirstToken(list, separators)

Parameter
Type
Description

separators

Returns: SalString.

StrGetNextToken()

Returns the next token string in a list.

Returns: SalString.

StrMetaphone(text)

Parameter
Type
Description

Returns: SalString.

StrNAny(text, chars)

Finds the first character in the string that does not appear in a given character set.

Parameter
Type
Description

Returns: SalNumber.

StrScan(text, search, index)

Searches for a substring in the source string starting from the specified index.

Parameter
Type
Description

Returns: SalNumber.

StrScanR(text, search, index)

Searches for a substring in the source string starting from the specified index.

Parameter
Type
Description

Returns: SalNumber.

StrSetCharAt(text, index, charSet)

Parameter
Type
Description

Returns: SalNumber.

StrToHex(str)

Converts a string to a hexadecimal text.

Parameter
Type
Description

Returns: SalString.

StrToNumber(text)

Converts a string to a number, regardless of the decimal point.

Parameter
Type
Description

Returns: SalNumber.

StrUncompress(inString, outString)

Parameter
Type
Description

inString

outString

Returns: SalBoolean.

TblCopyRows(table, flagsOn, flagsOff, copyFlags)

Copies the matching rows to the clipboard.

Parameter
Type
Description

Returns: SalBoolean.

TblCopyRowsToString(table, flagsOn, flagsOff, copyFlags, csvText)

Parameter
Type
Description

Returns: SalBoolean.

TblGetCellBackColor(column, backColor)

Parameter
Type
Description

column

backColor

Returns: SalBoolean.

TblGetCellCustom(column, userValue)

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblGetCellFont(column, hFont)

Parameter
Type
Description

Returns: SalBoolean.

TblGetCellFont(column)

Returns the font associated with the specified table cell.

Parameter
Type
Description

column

Returns: Font.

TblGetCellImage(column, hImage, position)

Parameter
Type
Description

Returns: SalBoolean.

TblGetCellImage(column, position)

Parameter
Type
Description

Returns: Image.

TblGetColHeaderCustom(column, userValue)

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblGetColHeaderFont(column, hFont)

Parameter
Type
Description

Returns: SalBoolean.

TblGetColHeaderFont(column)

Returns the font associated to the column header.

Parameter
Type
Description

column

Returns: Font.

TblGetColHeaderImage(column, hImage, position)

Parameter
Type
Description

Returns: SalBoolean.

TblGetColumnBackColor(column, backColor)

Parameter
Type
Description

column

backColor

Returns: SalBoolean.

TblGetColumnCustom(column, userValue)

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblGetColumnFont(column, hFont)

Parameter
Type
Description

Returns: SalBoolean.

TblGetColumnFont(column)

Returns the font associated with the specified table column.

Parameter
Type
Description

column

Returns: Font.

TblGetColumnImage(column, hImage, flags)

Parameter
Type
Description

Returns: SalBoolean.

TblGetCustomInfo(lParam, HDC, col, row, tag, left, top, right, bottom)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowBackColor(table, row, color)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowCustom(table, row, userValue)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowFont(table, row, hFont)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowFont(table, row)

Returns the font used for the specified row.

Parameter
Type
Description

Returns: Font.

TblGetRowImage(table, row, hImage, flags)

Parameter
Type
Description

Returns: SalBoolean.

TblPasteRows(table, copyFlags)

Pastes the CSV text from the clipboard.

Parameter
Type
Description

Returns: SalBoolean.

TblPasteRowsFromString(table, flags, csvText)

Pastes the specified CSV string into the table window control.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellBackColor(column, backColor)

Sets the background color of an individual cell.

Parameter
Type
Description

column

backColor

Returns: SalBoolean.

TblSetCellCustom(column, userValue)

Makes the specified cell custom-drawn and assigns the user value to it.

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblSetCellFont(column, font)

Sets the font for a single cell.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetCellFont(column, hFont)

Sets the font for a single cell.

Parameter
Type
Description

column

Returns: SalBoolean.

TblSetCellFontName(column, fontName, fontSize, fontEnh)

Sets the font for a single cell.

Parameter
Type
Description

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

TblSetCellImage(column, image, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImage(column, hImage, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageFile(column, file, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageResource(column, name, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageString(column, sImage, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetClipRect(lParam, left, top, right, bottom)

Changes the clipping rectangle when custom drawing a cell. It must be used when processing SAM_DrawCell to make sure that lParam contains the correct value.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderCustom(column, userValue)

Defines the column header as custom drawn.

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblSetColHeaderFont(column, font)

Assigns the specified font to the column header.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetColHeaderFont(column, hFont)

Assigns the specified font to the column header.

Parameter
Type
Description

column

Returns: SalBoolean.

TblSetColHeaderFontName(column, fontName, fontSize, fontEnh)

Creates the specified font and assigns it to the column header.

Parameter
Type
Description

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

TblSetColHeaderImage(column, image, flags)

Assigns the image from the handle to the specified column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImage(column, hImage, flags)

Assigns the image from the handle to the specified column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageFile(column, imageFile, flags)

Assigns the image file to the specified column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageResource(column, resName, flags)

Assigns the image from the specified resource object to the column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageString(column, imageBlob, flags)

Assigns the image from the blob string to the specified column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnBackColor(column, backColor)

Sets the background color for a table column.

Parameter
Type
Description

column

backColor

Returns: SalBoolean.

TblSetColumnCustom(column, userValue)

Enables custom drawing (SAM_DrawCell) for the specified column.

Parameter
Type
Description

column

userValue

Returns: SalBoolean.

TblSetColumnFont(column, font)

Sets the font for a table column.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetColumnFont(column, hFont)

Sets the font for a table column.

Parameter
Type
Description

column

Returns: SalBoolean.

TblSetColumnFontName(column, fontName, fontSize, fontEnh)

Sets the font for the table column. The font is created using the specified arguments.

Parameter
Type
Description

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

TblSetColumnImage(column, image, flags)

Assigns an image to a table column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImage(column, hImage, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageFile(column, file, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageResource(column, name, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageString(column, sImage, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetDelimiters(colDelimiter, rowDelimiter)

Changes the standard column and row delimiters for the copy/paste operations.

Parameter
Type
Description

colDelimiter

rowDelimiter

Returns: SalBoolean.

TblSetRowBackColor(table, row, color)

Sets the background color of a row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowCustom(table, row, userValue)

Defines the specified row as custom drawn and assigns the user value.

Parameter
Type
Description

table

userValue

Returns: SalBoolean.

TblSetRowFont(table, row, font)

Sets the font for the entire row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowFont(table, row, hFont)

Sets the font for the entire row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowFontName(table, row, fontName, fontSize, fontEnh)

Sets the font for the entire row.

Parameter
Type
Description

table

fontName

fontSize

fontEnh

Returns: SalBoolean.

TblSetRowHeaderBackColor(table, row, color)

Sets the background color of the row header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImage(table, row, image, flags)

Assigns an image to all the cells in the specified row,

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImage(table, row, hImage, flags)

Assigns an image to all the cells in the specified row,

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageFile(table, row, imageFile, flags)

Assigns an image to all the cells in the specified row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageResource(table, row, resName, flags)

Assigns the image from the resource object to all the cells in the table row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageString(table, row, imageBlob, flags)

Assigns an image to all the cells in the specified row.

Parameter
Type
Description

Returns: SalBoolean.

TblSortRows(table, colID, flags)

Sort the table rows using the values in the specified column.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxCreate(parent, name, position, flags)

Creates the specified toolbox dialog.

Parameter
Type
Description

Returns: SalWindowHandle.

ToolboxDestroy(parent, name)

Closes the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxGetButtonHandle()

hWndButton = XSalToolboxGetButtonHandle( )

Returns: SalWindowHandle.

ToolboxGetFlags(parent, name)

Returns the style flags for the specified toolbox.

Parameter
Type
Description

Returns: ToolboxFlags.

ToolboxGetPosition(parent, name)

Returns the position of the specified toolbox.

Parameter
Type
Description

Returns: ToolboxPositions.

ToolboxHide(parent, name)

Hides the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxHideAll(parent)

Hides all the toolboxes.

Parameter
Type
Description

parent

Returns: SalBoolean.

ToolboxIsVisible(parent, name)

Tests the visibility of the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxSetButtonStyle(button, style)

Applies the toolbox button styles to the button control. The button must be derived from XSalFlatButton.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxSetMetrics(value, type)

Sets metrics values for the tool bars.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxSetPosition(parent, name, position)

Changes the position of the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxShow(parent, name)

Shows the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxShowAll(parent)

Shows all the toolboxes.

Parameter
Type
Description

parent

Returns: SalBoolean.

ToolboxUpdate(parent, name)

Reloads all the child controls in the toolbox and updated the layout.

Parameter
Type
Description

Returns: SalBoolean.

TooltipInit()

Initializes the XSalTooltip component.

Returns: SalNumber.

TooltipSetColors(textColor, backColor)

Changes the tool tip colors.

Parameter
Type
Description

textColor

backColor

Returns: SalNumber.

TooltipSetDelay(showDelay, popDelay)

Sets the two timers delay in milliseconds. The first delay regulates the delay between the first time the mouse enters the window and the showing of the tool tip. The second delay regulates how long the tool tip stays on the screen.

Parameter
Type
Description

showDelay

popDelay

Returns: SalNumber.

TooltipSetText(tooltip)

Sets the tool tip text in response to SAM_TooltipSetText.

Parameter
Type
Description

tooltip

Returns: SalBoolean.

TooltipShow(ctrl, tooltip)

Shows the tool tip for the specified control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

tooltip

Returns: SalWindowHandle.

UdvArrayDelete(array, index)

Removes an element from the array.

Parameter
Type
Description

Returns: SalBoolean.

UdvArrayInsert(array, index)

Inserts a new element in the array.

Parameter
Type
Description

Returns: SalBoolean.

UdvArrayMove(array, sourceIndex, targetIndex)

Moves the element to the target index in the array.

Parameter
Type
Description

sourceIndex

targetIndex

Returns: SalBoolean.

UdvArraySort(array, fieldName, dataType, sortOrder)

Sorts the objects in the array using the value in the variable specified in sFieldName.

Parameter
Type
Description

fieldName

dataType

sortOrder

Returns: SalBoolean.

UdvArraySwap(array, index1, index2)

Swaps two object items in an array.

Parameter
Type
Description

Returns: SalBoolean.

UdvClone(source, target)

Parameter
Type
Description

Returns: SalBoolean.

UdvFromString(obj, source)

Parameter
Type
Description

Returns: SalBoolean.

UdvToString(obj, target)

Parameter
Type
Description

Returns: SalBoolean.

ZipCloseArchive(zipFile)

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipCloseFile(zipFile)

Closes the currently open zip entry. It doesn't close the Zip archive, to close the archive you have to use XSal.ZipCloseArchive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipCreateFile(zipFile, fileName, date, comment, compressionLevel)

Creates a file in the Zip archive and sets the newly created file as the currently open file.

Parameter
Type
Description

zipFile

fileName

comment

compressionLevel

Returns: SalBoolean.

ZipFindFile(zipFile, fileName)

Returns the zip entry that matches the specified name.

Parameter
Type
Description

zipFile

fileName

Returns: SalBoolean.

ZipFindFirstFile(zipFile)

Positions the current zip entry to the first file in the archive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipFindNextFile(zipFile)

Positions the current zip entry to the next file in the archive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipGetFileInfo(zipFile, fileName, comment, date, compressedSize, uncompressedSize)

Parameter
Type
Description

zipFile

fileName

comment

compressedSize

uncompressedSize

Returns: SalBoolean.

ZipOpenArchive(zipFile, fileName, mode)

Parameter
Type
Description

zipFile

fileName

Returns: SalBoolean.

ZipOpenFile(zipFile)

Opens the current zip entry for reading in the Zip archive. It must be used after XSal.ZipFindFile or XSal.ZipFindFirstFile, or XSal.ZipFindNextFile.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipRead(zipFile, buffer, count)

Parameter
Type
Description

Returns: SalNumber.

ZipWrite(zipFile, buffer, length)

Writes the buffer to the currently open zip entry in the zip file.

Parameter
Type
Description

zipFile

buffer

length

Returns: SalBoolean.

ZipWrite(zipFile, buffer, length)

Writes the buffer to the currently open zip entry in the zip file.

Parameter
Type
Description

zipFile

buffer

length

Returns: SalBoolean.

Last updated