UniScript 4.x

New Functions in UniPlot 4.2.3

ReportControl_GetStyleNames

ReportControl_GetStyleNames returns a string vector with style names of the specified style file which can be used to initialize the marker combo box in a report control.

ReportControl_GetStyles

ReportControl_GetStyles returns the style names of the selected styles in the report control of a dialog box.

New Functions in UniPlot 4.2.2

AppEventWndClear

AppEventWndClear removes all events from the event window.

CreateListBoxText

CreateListBoxText creates the iniatialize string for list boxes and combo boxes.

GetListBoxText

GetListBoxText splits the return value of a combo box or list box into a string vector. The value is returned from the DialogBox function.

NC_GetVarNames

NC_GetVarNames returns the variable names of a netCDF data file (NC file).

ReportControl_GetColorNames

ReportControl_GetColorNames returns a string vector with color values and names.

ReportControl_GetColorRGB

ReportControl_GetColorRGB returns the color values of a marker control in a report control.

ReportControl_GetInit

ReportControl_GetInit converts a string matrix into a scalar string which can be used to initialize the report control in a dialog box.

ReportControl_GetLineStyle

ReportControl_GetLineStyle returns the line style value of a marker combo box of a report control.

ReportControl_GetLineStyleNames

ReportControl_GetLineStyleNames returns a string vector with line style names which can be used to initialize the marker combo box in a report control.

ReportControl_GetMarkerStyle

ReportControl_GetMarkerStyle returns the marker index of the marker selected in the report control in the dialog box.

ReportControl_GetMarkerStyleNames

ReportControl_GetMarkerStyleNames returns a string vector with marker names which can be used to initialize the marker combo box in a report control.

ReportControl_GetMatrix

ReportControl_GetMatrix converts the DialogBox return value for the report control into a matrix.

ReportControl_RemoveSelection

ReportControl_RemoveSelection is a helper function to remove the selected records from a report control. Add a button to the control and call this function in the button callback function.

ReportControl_SelUpOrDown

ReportControl_SelUpOrDown is a helper function to modify the record order in a report control. Add a button to the control and call this function in the button callback function.

ReportControl_Sort

The ReportControl_Sort callback function can be set in the dialog box template string of a report control to enable sorting of records. The function is invoked by UniPlot when the user clicks the buttons in the header of a report control.

New Functions in UniPlot 4.2.1

md5

md5 calculates the MD5 check sum using the algorithm http://www.faqs.org/rfcs/rfc1321.html, MD5 Message-Digest Algorithm (RFC 1321).

md5_file

md5_file calculates the MD5 check sum using the algorithm http://www.faqs.org/rfcs/rfc1321.html, MD5 Message-Digest Algorithm (RFC 1321).

New Functions in UniPlot 4.2.0

GridGetSwapRowCol

GridGetSwapRowCol checks if the channels are displayed in the Browser dialog in columns or rows.

GridReplaceFile

GridReplaceFile replaces the data file displayed in the Browser dialog.

GridSetSwapRowCol

GridSetSwapRowCol sets the display of the data channels in the data browser (channels can be displayed in rows or columns).

LayerMoveDataset

LayerMoveDataset moves datasets to the specified diagram. Datasets can only be moved inside a page. The function can also be used to change the drawing order of datasets.

LayerMoveObjects

LayerMoveObjects moves Objects to the specified diagram. Objects can only be moved inside a page. The function can also be used to change the drawing order of Objects.

OBJGetParentCB

OBJGetParentCB returns the handle of the parent group object.

RBSetMillimeterEx

RBSetMillimeterEx displays a millimeter grid in the rectangle object. The gridlines are drawn with the edge pen.

interpol

The interpol function executes a linear interpolation or cosine interpolation for the given x-coordinates.

mem_alloc

mem_alloc creates a scalar string of the given length.

mem_compare

mem_compare compares two strings or string matrices which may contain 0-characters.

mem_compress

mem_compress compresses a string which may contain 0-characters.

mem_get

mem_get reads bytes from a string and converts the data.

mem_len

mem_len returns the length in bytes of a scalar string or a matrix of strings.

mem_set

mem_set sets the bytes in a string to values of a specified data type.

mem_uncompress

mem_uncompress uncompresses a string that was compressed with mem_compress or zlib.

poly_poly_intersect

poly_poly_intersect returns the intersections of two polylines.

Changed Functions in UniPlot 4.2.0

@f{labeldatapoint}

Labels the data points of the original data with its y value.

DialogBox

DialogBox creates a dialog box with static text, edit fields, list boxes, combo boxes, check boxes, a report list (list with multiple columns), a property list box, a group box, tree control and buttons.The dialog box can be configured to be resizeable (see Dialog control |F @ xxx_callback|).

GridGetConfigInfo

GridGetConfigInfo returns a string vector with 6 elements containing the options, displayed in the option dialog box.

GridSetConfigInfo

GridSetConfigInfo sets the data browser configuration.

LayerGetAllDatasets

LayerGetAllDatasets returns the handles of all datasets.

MapLookup

MapLookup uses a hashing algorithm to quickly find the map element with a key that exactly matches the given key.

MapSetAt

MapSetAt means to insert an element in a map. First, the key is looked up. If the key is found, then the corresponding value is changed; otherwise a new key-value pair is created.

RegisterFunction

RegisterFunction registers a function from a dynamic link library (DLL) to the UniScript symbol table. After a function is registered, the function can be called directly by UniScript.

base64_decode

base64_decode decodes a string that had been encoded using the base64_encode function.

base64_encode

base64_encode encodes data into the base64 format

binary_decode

Is replaced by base64_encode.

binary_encode

Is replaced by base64_encode.

fread

fread reads data from a file.

sqlite_open

Removed, use sqlite3_open.

strcode

strcode returns the code values (numbers) of the given string.

strextract

strextract returns a substring of its argument string.

strlen

strlen returns the length of a string in bytes.

New Functions in UniPlot 4.1.2

OnImportUpdateNCFile

OnImportUpdateNCFile will be invoked by the frame work, when the user imports a datafile.

XYZGetIsoAreas

XYZGetIsoAreas returns the area between the isolines as a percent value of the complete map.

XYZGetIsoValuesScaleType

XYZGetIsoValuesScaleType returns information about the autoscaling of isoline values (Autoscale On/Off, Type, Number of values).

XYZGetLabelFormatType

XYZGetLabelFormatType returns a value that specifies how the decimal places of isoline labels are created (manually or automatically).

XYZGetLabelTypeIsolines

XYZGetLabelTypeIsolines returns the isoline label settings.

XYZSetIsoValues

XYZSetIsoValues sets the isoline values.

XYZSetIsoValuesScaleType

XYZSetIsoValuesScaleType specifies how the isoline values are calculated (atuomatically or manually).

XYZSetLabelFormatType

XYZSetLabelFormatType specifies how the decimal places of isoline values are calculated (manually or automatically).

XYZSetLabelTypeIsolines

XYZSetLabelTypeIsolines specifies how the isoline labels are placed in the dataset.

strmatchi

strmatchi returns a vector of indices of those matrix elements which match the given pattern.

New Functions in UniPlot 4.1.0

error_create

error_create creates an error object.

gc

gc invokes the garbage-collector.

obj_copy

obj_copy creates a copy of an object.

obj_count

obj_count returns the number of variables in an object.

obj_count_num

obj_count_num returns the number of number keys in an object.

obj_count_str

obj_count_str returns the number of string keys in an object.

obj_create

obj_create creates an UniScript object.

obj_has_key

obj_has_key checks if a given key exists.

obj_info

obj_info returns a string of the form “obj-name,hex-address”.

obj_keys

obj_keys returns all keys or a range of keys for the given object.

obj_load

obj_load loads an object saved with obj_save from the hard drive.

obj_lookup

obj_lookup returns the value of a given key.

obj_methods

obj_methods returns an object with methods (member functions) for the given object.

obj_parent

obj_parent returns the parent object or 0 if the object does not have a parent.

obj_remove

obj_remove removes a key-value pair from an object.

obj_save

obj_save saves an object as an XML file or as an binary file on the hard drive or as a string.

obj_set_at

obj_set_at adds a key-value pair to the given object. If the key already exists the value will be overwritten.

obj_set_methods

obj_set_methods sets the methods (member functions) for the given object.

obj_set_parent

obj_set_parent sets the parent object.

obj_set_str_return

obj_set_str_return specifies the return value of obj_lookup. If a key does not exist, obj_lookup may return 0, an empty string or throw an exception.

utf8_decode

utf8_decode converts an UTF8 string to an ANSI string.

utf8_encode

utf8_encode converts an ANSI string to an UTF8 string.

New Functions in UniPlot 4.0.3

XYGetProps

XYGetProps returns a string with properties of an x/y dataset.

XYSetDefault

XYSetDefault sets all dataset properties of 2D dataset to default.

XYSetProps

XYSetProps sets the dataset properties of a 2D dataset.

XYZGetProps

XYZGetProps returns the dataset properties of a 3D dataset (x/y/z).

XYZIsIsolinesVisible

XYZIsIsolinesVisible returns a nonzero value if the isolines are visible; otherwise 0.

XYZSetDefault

XYZSetDefault sets all dataset properties of a 3D dataset to default.

XYZSetProps

XYZSetProps sets the dataset properties of a 3D dataset.

XYZShowIsolines

XYZShowIsolines shows or hides the isolines.

nc_get_option

nc_get_option gets an option.

nc_set_option

nc_set_option sets an option.

New Functions in UniPlot 4.0.0

ADDIN_AddToUI

ADDIN_AddToUI adds a function to the UniPlot user interface.

DocGetProtectionComment

DocGetProtectionComment retrieves the comment that is displayed when a password protected document is opened.

DocGetProtectionFlags

DocGetProtectionFlags returns the protection flag.

DocIsReadOnly

DocIsReadOnly checks if the read-only flag is set.

DocSetProtectionFlags

DocSetProtectionFlags sets the password, the comment and the protection flag.

DocSetReadOnly

DocSetReadOnly sets the read-only flag.

EdFind

EdFind finds a string in an editor.

EdFindReplace

EdFindReplace replaces a string in an editor.

EdFoldAll

EdFoldAll

EdGetCurrentPos

EdGetCurrentPos returns the cursor position in characters from the beginning of the file.

EdGetCursorPos

EdGetCursorPos returns the cursor position in column/row coordinates.

EdGetLineFromPos

EdGetLineFromPos returns the line number for the given position.

EdGetMarginType

EdGetMarginType

EdGetPosFromLine

EdGetPosFromLine returns the position of the given line. The position is the number of characters from the beginning of the file.

EdGetWnd

EdGetWnd returns the window handle

EdGotoPos

EdGotoPos sets the cursor to the given position

EdIsReadOnly

EdIsReadOnly checks if the read-only flag is set.

EdSetMarginType

EdSetMarginType

EdSetReadOnly

EdSetReadOnly sets the read-only flag.

EdToggleFolding

EdToggleFolding

GetProfileSection

GetProfileSection returns all keys with their values of the specified section in the form key=value.

GetProfileSectionNames

GetProfileSectionNames returns a string vector with the section names.

GridLoadCallback_xxx

GridLoadCallback_xxx is called when the user presses the Load button in the data browser.

GridLoadEnableCallback_xxx

GridLoadEnableCallback_xxx

ImageIsFrame

ImageIsFrame checks if the picture frame is visible.

ImageMirror

ImageMirror reflects the image vertically.

ImageRotate90

ImageRotate90 rotates the image by 90 degrees clockwise or counterclockwise.

ImageSaveAs

ImageSaveAs saves the picture in its orignal format as a file.

ImageShowFrame

ImageShowFrame shows or hides the frame of the picture.

NC_DlgGetFileName

The NC_DlgGetFileName function returns the NC file name of the currently open file in the NC file browser.

OLESavePicture

OLESavePicture saves one OLE object in a file.

PageSetBackgroundPageName

PageSetBackgroundPageName selects the page given by its name to be displayed in the background. The page must belong to the same document.

PageSetForegroundPageName

PageSetForegroundPageName selects the page given by its name to be displayed in the foreground. The page must belong to the same document.

RemoveDirectory

RemoveDirectory deletes an existing directory. The directory must be empty, and it must not be the current working directory or the root directory.

SynEdFind

Is replaced by EdFindReplace.

SynEdFindText

Is replaced by EdFind.

SynEdFoldAll

Is replaced by EdFoldAll.

SynEdGetMarginType

Is replaced by EdGetMarginType.

SynEdSetMarginType

Is replaced by EdSetMarginType

SynEdToggleFolding

Is replaced by EdToggleFolding.

TYAddData

TYAddData adds data to a y/t dataset (1D dataset).

TYSetData

TYSetData sets the coordinates of a y/t datasets (1D-dataset).

TableAddBrush

TableAddBrush adds a new bush (fill color) to the brush list.

TableAddFont

TableAddFont adds a font to font list of a table object.

TableAddFormat

TableAddFormat adds a format string and cell type to a table object.

TableAddPen

TableAddPen adds a pen to the list of pens of the specified table object.

TableCreate

TableCreate create a new table object.

TableDeleteColumn

TableDeleteColumn deletes a table column.

TableDeleteRow

TableDeleteRow removes the specified row from the table

TableDestroy

TableDestroy destroys the given table object and frees any memory the object occupied.

TableGetAlign

TableGetAlign retrieves the text alignment for all cells or a range of cells.

TableGetAttrib

TableGetAttrib returns a matrix of cell attributes.

TableGetBorderPenIndex

TableGetBorderPenIndex

TableGetBrushIndex

TableGetBrushIndex returns a matrix with the brush indices.

TableGetBrushList

TableGetBrushList returns a matrix with 3 columns. Each row specifies a color used in the table.

TableGetColumnWidth

TableGetColumnWidth returns a vector with column width in centimeters.

TableGetEdgeDistance

TableGetEdgeDistance returns the distance between the text and the left cell edge.

TableGetFontIndex

TableGetFontIndex returns a vector of font indices.

TableGetFontList

TableGetFontList returns a vector with font handles.

TableGetFormatIndex

TableGetFormatIndex returns a matrix with the format indices.

TableGetFormatList

TableGetFormatList returns a string matrix with two columns with cell format information.

TableGetName

TableGetName returns a matrix of cell names.

TableGetPenList

TableGetPenList returns a vector with pen handles. A pen is used to draw the cell border line.

TableGetRowHeight

TableGetRowHeight returns a vector with row heights in centimeters.

TableGetSelection

TableGetSelection returns the current selection.

TableGetSize

TableGetSize returns the number of rows and columns.

TableGetText

TableGetText returns a matrix of cell text.

TableGetTextAngle

TableGetTextAngle returns the text directions of all cells or a selection of cells.

TableGetTextExt

TableGetTextExt returns the width and height of cell text.

TableInsertColumn

TableInsertColumn inserts a new column of cells to the specified table.

TableInsertRow

TableInsertRow inserts a new row of cells to the specified table.

TableIsCellMerged

TableIsCellMerged returns TRUE (1) if the specified cell belongs to a merged cell.

TableIsPlaceholderDialogUsed

TableIsPlaceholderDialogUsed

TableMergeCells

TableMergeCells specifies which neighbouring cells are merged.

TableRedo

TableRedo

TableSetAlign

TableSetAlign sets the text alignment for all cells or a range of cells.

TableSetAttrib

TableSetAttrib sets the cell attributes.

TableSetBorderPenIndex

TableSetBorderPenIndex sets the pen index that is used to draw the border. Every cell is enclosed by 4 border lines.

TableSetBrushIndex

TableSetBrushIndex sets the brush indices.

TableSetColumnWidth

TableSetColumnWidth sets the column width in centimeters.

TableSetEdgeDistance

TableSetEdgeDistance sets the distance between the text and the cell edge.

TableSetFontIndex

TableSetFontIndex sets the font index.

TableSetFormatIndex

TableSetFormatIndex sets the format indices.

TableSetName

TableSetName sets the cell name.

TableSetRowHeight

TableSetRowHeight sets the row height in centimeters.

TableSetSelection

TableSetSelection sets the selection.

TableSetText

TableSetText sets the cell text.

TableSetTextAngle

TableSetTextAngle sets the text direction of all cells or a selection of cells.

TableUnMergeCell

TableUnMergeCell splits a merged cell.

TableUndoEnd

TableUndoEnd

TableUndoStart

TableUndoStart

TableUsePlaceholderDialog

TableUsePlaceholderDialog spedifies the dialog box which will be displayed if the table is double-clicked.

XYGetErrorbarConfig

XYGetErrorbarConfig returns the error bar settings.

XYGetFilterFunctions

XYGetFilterFunctions returns a scalar string with filter functions.

XYGetGetOrgDataFlag

XYGetGetOrgDataFlag returns the flag set with XYSetGetOrgDataFlag.

XYGetScaleOffset

XYGetScaleOffset gets the scaling for the x- and y coordinates of the given dataset.

XYIsFilterUsed

XYIsFilterUsed checks if the original data or the filtered data is displayed.

XYIsMarkerOrgData

XYIsMarkerOrgData checks if the marker are displayed for the original data points or the filtered data points.

XYIsMonoton

XYIsMonoton returns TRUE (1) if the x-coordinates are strictly monoton increasing.

XYSetData

XYSetData sets the xy-coordinates of a dataset.

XYSetErrorbarConfig

XYSetErrorbarConfig sets the error bar settings.

XYSetFilterFunctions

XYSetFilterFunctions sets one or more filter functions for a 2D dataset.

XYSetGetOrgDataFlag

XYSetGetOrgDataFlag specifies if the XYGetData function returns the original data or the filtered data.

XYSetScaleOffset

XYSetScaleOffset sets the scaling for the x- and y-coordinates of the given dataset.

XYShowMarkerOrgData

XYShowMarkerOrgData specifies if the dataset markers are displayed for the original data or the filtered data.

XYUpdate

The XYUpdate functions recalculates the filter functions of a 2D dataset.

XYUseFilter

XYUseFilter specifies if the filter functions are used to calculate the output data.

XYZGetBubbleAttribute

XYZGetBubbleAttribute returns the bubble plot settings.

XYZGetBubbleScaleValues

XYZGetBubbleSize returns the bubble scaling values.

XYZGetBubbleSize

XYZGetBubbleSize returns the bubble diameter in centimeters.

XYZIsBubbleVisible

XYZIsBubbleVisible indicates whether the bubbles are visible.

XYZSetBubbleAttribute

XYZSetBubbleAttribute sets the bubble plot attributes.

XYZSetBubbleScaleValues

XYZSetBubbleScaleValues sets the scale values to calculate the bubble size.

XYZSetBubbleSize

XYZSetBubbleSize sets the bubble size in centimeters.

XYZShowBubble

XYZShowBubble shows or hides bubbles marking the original position of the data points. The bubble size and fill color can depend on the Z-Value.

_mem

_mem returns the size of used memory allocated by UniScript.

base64_decode

base64_decode decodes a string that had been encoded using the base64_encode function.

base64_encode

base64_encode encodes data into the base64 format

binary_decode

Is replaced by base64_encode.

binary_encode

Is replaced by base64_encode.

eval

eval evaluates the string given as UniScript code.

eval_file

eval_file loads a file with UniScript program code.

evalp

evalp evaluates UniScript program code.

evalp_file

evalp_file loads a file with UniScript program code.

get_prototype

get_prototype returns the prototype string of a UniScript function.

nc_filename

nc_filename returns the file name for a given ncid.

nc_varcopy

nc_varcopy copies the data of a variable from one NC file to another NC file. The variable must exist in both files and must have the same number of points.

profiler_start

profiler_start starts the profiler. The profiler can be used for analyzing the run-time behavior and performance of programs.

profiler_stop

profiler_stop stops the profiler that has been started with the profiler_start function. The profiler can be used for analyzing the run-time behavior and performance of programs.

Altered Functions in UniPlot 4.0.0

DocCreate

DocCreate creates a new document or opens an existing document. The document can contain pages with diagrams. The document will be displayed in a window.

GetExceptionInfo

GetExceptionInfo returns the current exception information vector.

GetTickCount

GetTickCount returns the number of milliseconds that have elapsed since UniPlot was started.

GetUserDirectory

GetUserDirectory returns the UniPlot user directory.

ImageCreate

ImageCreate creates a picture object.

ImageGetLinkType

ImageGetLinkType returns the link type.

MnGetStrings

MnGetStrings returns the menu item strings of the specified menu.

PageSaveAsBitmap

PageSaveAsBitmap creates a bitmap (.BMP) or JPEG (.JPG) file from the given page.

TYCreate

TYCreate creates a new y/t datasets (1D dataset).

TYSetMinAndDelta

TYSetMinAndDelta sets the minimum value x-min and the distance delta between 2 x-coordinates.

XYAddData

The XYAddData function adds data to an existing dataset.

XYIsSpline

XYIsSpline determines whether the data points are connected by a spline.

XYIsTYDataset

XYIsTYDataset determines whether the dataset is a 1D dataset (yt-dataset).

XYSetSpline

XYSetSpline determines if the data points should be connected with a spline or a polygon.

poly_hull

poly_hull calculates the convex hull in the x/y plane.

tic

tic retrieves the number of milliseconds that have elapsed since UniPlot was started.

Obsolete Functions

AppSetTimer

Is replaced by AppNewTimer.

ConvertToVariant

Is replaced by vconvert.

EdLimitText

Deprecated.

Event_Error

Is replaced by log_error.

Event_Information

Is replaced by log_info.

Event_Warning

Is replaced by log_warning.

Round

Is replaced by fround.

RoundDown

Is replaced by fround.

RoundUp

Is replaced by fround.

SynEdCreate

Is replaced by EdCreate.

SynEdFind

Is replaced by EdFindReplace.

SynEdFindText

Is replaced by EdFind.

SynEdFoldAll

Is replaced by EdFoldAll.

SynEdGetMarginType

Is replaced by EdGetMarginType.

SynEdSetMarginType

Is replaced by EdSetMarginType

SynEdToggleFolding

Is replaced by EdToggleFolding.

VariantConvert

Is replaced by vcast.

VariantGetType

Is replaced by vtype.

XYSetNewData

Is replaced by XYSetData.

XYZIsInterLinear

Is replaced by XYZGetInterpolationType.

XYZSetInterLinear

Is replaced by XYZSetInterpolationType.

auto_SetImportOptions

Function is deprecated. The import options will be created automatically during import.

binary_decode

Is replaced by base64_encode.

binary_encode

Is replaced by base64_encode.

finite

finite checks if the argument is 0/0 or 1/0.

inf

inf returns the result of 1/0.

isinf

isinf checks if its argument is in the range -INF … INF.

nan

nan (Not a Number) returns the number 0/0.

sqlite_busy_timeout

Removed, use sqlite3_busy_timeout.

sqlite_close

Removed, use sqlite3_close.

sqlite_execute

Removed, use sqlite3_execute.

sqlite_last_insert_rowid

Removed, use sqlite3_last_insert_rowid.

sqlite_libencoding

Removed, use sqlite3_libencoding.

sqlite_libversion

sqlite_libversion returns the SQLite library version.

sqlite_open

Removed, use sqlite3_open.

id-1903559