Function Summary

The following table lists all functions available.

Function Name	Description
abs	Absolute value
ACSourceDialog	Displays dialog box intended for the user definition of an AC source
AddConfigCollection	Adds a list of entries to a named section in the configuration file
AddGraphCrossHair	Adds a new cursor to the current graph
AddModelFiles	Installs Model Files
AddPropertyDialog	User interface function. Open add property dialog for symbol editor
AddRemoveDialog	User interface function. Allows selection of a list of items.
AddRemoveDialogNew	User interface function. Allows selection of a list of items.
AddSymbolFiles	Adds file or files to list of installed symbol library files
area	Calculates the area under a curve
arg	Phase of argument in degrees. Result always between -180 to 180
arg_rad	Phase of argument in radians. Result always between $-\pi$ to $\pi$
Ascii	Returns ASCII code for character
AssociateModel	Special purpose function for managing parts browser.
atan	Arc Tangent (radians)
atan_deg	Arc Tangent (degrees)
avg	Returns the average of argument
BoolSelect	User interface function. Returns state of up to 6 check boxes
Branch	Returns branch current formula of schematic net nearest cursor
CanOpenFile	Returns TRUE if specified file exists and can be opened for read
ChangeDir	Change current working directory
Char	Returns character from string
ChooseDir	User interface function. Returns user selected pathname.
ChooseDirectory	User interface function. Returns user selected pathname.
Chr	Returns a string consisting of a single character specified by an ASCII code
CloseEchoFile	Closes the file associated with the Echo command. (See also
CloseFile	Closes a file opened using OpenFile
CloseSchematic	Close a schematic handle opened using
CloseSchematicTab	Close a schematic using ID
CollateVectors	Returns vector data in an interleaved manner
CommandStatus	Obtain information about the current script execution context
CompareSymbols	Compare two schematic symbols
ComposeDigital	Builds a new vector from a binary weighted combination of digital vectors
ConvertLocalToUnix	Convert file name to UNIX format using `/'
ConvertUnixToLocal	Convert file name to the local format.
CopyTree	Copy a directory tree
CopyURL	Copy a file to or from a location defined by a URL. Supports http, ftp and local files.
cos	Cosine (radians)
cos_deg	Cosine (degrees)
cosh	Hyperbolic cosine (radians)
CreateDiodeDialog	Opens a specialised dialog used by the diode model in-circuit parameter extractor
CreateLockFile	Create or remove a lock file for specified file.
CreateNewTitleBlockDialog	Displays the title block creation dialog
CreateShortcut	Create a shortcut to the specified path
CreateTimer	Create a timer to schedule events in the future
cv	Alias to
CyclePeriod	Returns the time between zero crossing pairs with the same slope direction. It can be used for plotting frequency vs time
Date	Return current system date in string form
db	$dB(x) = 20 \times \text{log10} ( \text{
DCSourceDialog	Opens `Edit DC Source' dialog box
DefineADCDialog	UI function to define generic ADC
DefineArbSourceDialog	UI function to define arbitrary source
DefineBusPlotDialog	Opens a dialog box to allow the user to plot a bus
DefineCounterDialog	UI function to define generic counter
DefineCurveDialog	Opens define curve dialog box
DefineDACDialog	UI function to define generic DAC
DefineFourierDialog	UI function, opens define fourier dialog
DefineIdealTxDialog	UI function to define ideal transformer
DefineLaplaceDialog	UI function to define S-domain transfer function
DefineLogicGateDialog	UI function to define generic logic gate
DefinePerfAnalysisDialog	UI function for defining a performance analysis
DefineRegisterDialog	UI function to define Bus register
DefineRipperDialog	UI function to define schematic bus ripper
DefineSaturableTxDialog	Open dialog box to define a saturable transformer
DefineShiftRegDialog	UI function to define generic shift register
DefineSimplisMultiStepDialog	Open dialog box to define SIMPLIS multi-step dialog.
DeleteConfigCollection	Deletes a list of entries in the config file
DeleteTimer	Deletes a timer
DeleteTree	Delete an entire directory tree
DescendDirectories	Returns all directories under the specified directory, recursing through all sub-directories
DescendHierarchy	Analyse schematic hierarchy
DialogDesigner	Simple dialog designer
diff	Return derivative of argument
DirectoryIsWriteable	Tests whether or not a directory can be written to
Distribution	Returns random number with a custom distribution
EditArcDialog	UI function to edit symbol editor arc
EditAxisDialog	UI function, opens edit axis dialog
EditBodePlotProbeDialog	UI function for editing Bode plot fixed probes
EditCrosshairDimensionDialog	UI function, opens dialog for editing cursor dimension
EditCurveMarkerDialog	UI function, opens dialog to edit curve marker
EditDeviceDialog	UI function to select device and edit device parameters
EditDigInitDialog	UI function to edit digital initial condition
EditFreeTextDialog	UI function, opens dialog to edit graph free text object
EditGraphTextBoxDialog	UI function, opens dialog to edit graph text box object
EditLegendBoxDialog	UI function, opens dialog to edit graph legend box object
EditObjectPropertiesDialog	UI function, opens dialog to edit property values
EditPinDialog	UI function to edit symbol editor pins
EditPotDialog	UI function to edit potentiometer properties
EditProbeDialog	UI function, opens edit fixed probe dialog
EditPropertyDialog	UI function to edit symbol editor properties
EditReactiveDialog	Opens a dialog box designed to edit inductors and capacitors
EditSelect	User interface function. Returns entries in up to 6 edit controls
EditSimplisMosfetDriverDialog	Opens a specialized dialog used to edit the parameters for a SIMPLIS Multi-Level MOSFET Driver.
EditStylesDialog	Opens the Edit Styles dialog
EditTimer	Edit a timer
EditWaveformDialog	Opens the dialog box editing a time domain waveform
EditWaveformStrDialog	Opens the dialog box editing a time domain waveform
ElementProps	Returns selected element's properties
EnterTextDialog	UI function to define multi line text
EpochTime	Returns absolute time in seconds
erf	Calculate erf(x)
erfc	Calculate erfc(x)
EscapeString	Process string and replace escaped characters with literals
EscapeStringEncode	Process string and replace literals with escaped characters.
ev	Special function used to evaluate a sequence of expressions
Execute	Execute script as a function
ExistCommand	Tests if a command exists
ExistDir	Checks if the specified directory exists
ExistFile	Tests whether a file exists
ExistFunction	Returns TRUE if the specified function exists.
ExistSymbol	Returns TRUE if specified schematic symbol exists.
ExistVec	Returns TRUE if specified schematic symbol exists.
exp	Exponential
fft	Fast Fourier Transform
Field	Provides bit-wise access to integers
FilterEditMenu	Filters a menu list to return only menu definitions that are actually displayed
FilterFile	Filters specific lines from a text file.
FindModel	Returns location of simulator model given name and type
FIR	Finite Impulse Response digital filter
Floor	Returns argument truncated to next lowest integer
floorv	Returns arguments truncated to next lowest integers, as a vector
FormatNumber	Returns formatted number in string form
Fourier	Performs a spectral analysis using the continuous Fourier algorithm
FourierOptionsDialog	UI function, opens fourier options dialog
FourierWindow	Apply window function for fourier analysis
FullPath	Returns full path name of given relative path
gamma	Calculate gamma(x)
Gauss	Returns random number with Gaussian distribution
GaussLim	Returns random number with Gaussian distribution truncated at the tolerance limits. Alias of function
GaussTrunc	Returns random number with Gaussian distribution truncated at the tolerance limits
GenPrintDialog	UI function, opens print dialog box
GetActualPath	Returns a file system path resolving any links
GetAllCurves	Returns array of curve indexes for all curves in current graph
GetAllSimulatorDevices	Returns details of all simulator built-in devices
GetAllSymbolPropertyNames	Finds names of all the properties on currently open symbol
GetAllYAxes	Returns array of axis id's for all y axes in current graph
GetAnalysisInfo	Return information about most recent analysis
GetAnalysisLines	Returns the analysis lines used in the most recent simulation analysis
GetAnnotationText	Returns the text of the requested annotation
GetAxisCurves	Returns array of curve id's for all curves attached to specified axis
GetAxisLimits	Returns min and max limits and axis type (log or lin) of specified axis
GetAxisType	Returns type (X, Y, Digital etc.) of specified axis
GetAxisUnits	Returns units of specified axis
GetChildModulePorts	Finds information about module ports in the underlying schematic of a hierarchical block
GetCodecNames	Returns encoding types available
GetColours	Return names of all colour objects
GetColourSpec	Return specification for a colour object
GetCompatiblePathName	Returns a path name with no white space.
GetComponentValue	Special function to get a component value or parameter
GetConfigLoc	Return location of config information
GetConnectedPins	Returns instance and pin name for all instances connected to net at specified point
GetConvergenceInfo	Return convergence data for most recent simulation
GetCurDir	Returns current working directory.
GetCurrentGraph	Returns id of the currently selected graph.
GetCurrentStepValue	Get current step value in a script-based multi-step analysis
GetCursorCurve	Returns curve id and source group name of curve attached to measurement cursor
GetCurveAxis	Returns axis id of specified curve
GetCurveName	Returns name of specified curve
GetCurves	Returns curve names in selected graph
GetCurveVector	Returns data associated with a graph curve
GetDatumCurve	Returns curve id and source group name of curve attached to reference cursor
GetDeviceDefinition	Retrieve the text of a model definition from library
GetDeviceInfo	Returns information about the specified simulator device
GetDeviceParameterNames	Returns list of device parameter names for specified SPICE device
GetDevicePins	Get electrical connections of a simulator device
GetDeviceStats	Get simulation statistics for each device type
GetDotParamNames	Returns names of .PARAM variables used in latest simulation
GetDotParamValue	Returns value of specified .PARAM value in latest simulation run
GetDriveType	Determines the type of drive or file system of the specified path
GetEmbeddedFileName	Returns the actual file name used for an embedded file specified using `.FILE' and `.ENDF'
GetEnvVar	Return specified system environment variable
GetEthernetAddresses	Returns information about the installed Ethernet adapters
GetF11Lines	Returns the contents of the schematic's text window (also known as the F11 window)
GetFile	User interface function. Returns user selected file name
GetFileCD	User interface function. As GetFile but changes directory.
GetFileDir	Get the directory where the specified file is located
GetFileExtensions	Returns file extensions for specified SIMetrix file type
GetFileInfo	Returns information about a specified file
GetFileSave	User interface function. Returns user selected file name for saving
GetFileVersionStamp	Returns file version stamp
GetFileViewerSelectedFiles	Returns file names of selected files in the File Views
GetFirstSelectedElementOfType	Returns handle of first selected schematic element of the requested type
GetFonts	Return names of all font objects
GetFontSpec	Return specification for named font
GetFreeDiskSpace	Returns space available on specified disk volume
GetGraphObjects	Return IDs for specified graph objects
GetGraphObjPropNames	Return property names for specified graph object
GetGraphObjPropValue	Return value for a graph object property
GetGraphObjPropValues	Return value for a graph object property
GetGraphTabs	Return graph ids for graph tabbed sheets
GetGraphTitle	Return current graph title
GetGroupInfo	Returns information about a group
GetGroupStepParameter	Returns the name of the `stepped parameter' of a multi-step run
GetGroupStepVals	Returns the `stepped values' in a multistep run
GetHighlightedWidgetId	Returns ID of highlighted widget
GetHostId	Get hostid that can be used for licensing
GetInstanceParamValues	Returns parameter values for a simulator device
GetInstancePinLocs	Returns pin locations of specified instance
GetInstsAtPoint	Returns instances at specified point
GetInternalDeviceName	Finds the simulator's internal device name for a model
GetKeyDefs	Returns details of all key definitions created using
GetLaplaceErrorMessage	Convert
GetLastCommand	Retrieve last command issued by a menu or toolbar
GetLastError	Returns result of most recent command
GetLegendProperties	Returns array of legend property
GetLibraryModels	Returns a string array containing information about each model in the specified model library
GetLicenseInfo	Returns information about the current license
GetLicenseStats	Returns information about the license check out process
GetLine	Returns a single line from a file.
GetListSelected	Return list of selected elements from the ListSubsetDialog
GetListUnselected	Return list of unselected elements from the ListSubsetDialog
GetLongPathName	Returns long path name for path specified either as a long or short path
GetMaxCores	Return maximum cores available taking account of hardware capability and license
GetMenuItems	Returns all menu item names in the specified menu
GetModelFiles	Returns a list of currently installed device models.
GetModelLibraryErrors	Returns list of error messages from model library install operations
GetModelName	Returns the model name used by a simulator device
GetModelParameterNames	Returns the names of all real valued parameters of a simulator device model
GetModelParameters	Returns information about a device's model parameters
GetModelParameterValues	Returns the values of all parameters of a simulator model
GetModelType	Returns the simulator internal device name given a user model name
GetModifiedStatus	Returns modified status of the specified schematic
GetNamedSymbolPins	Returns the names for all the pins of a symbol or hierarchical component
GetNamedSymbolPropNames	Returns names of all properties defined for a library symbol
GetNamedSymbolPropValue	Returns the value of a property defined for a library symbol
GetNearestNet	Returns information about the schematic net nearest the mouse cursor
GetNextDefaultStyleName	Returns next fully available default style name
GetNodeNames	Returns all node names used in most recent simulation
GetNonDefaultOptions	Returns names of all explicit .OPTION settings in the most recent simulation
GetNumCurves	Returns number of curves in curve group
GetOpenSchematics	Returns the path names of all open schematics
GetOption	Returns the value of an option variable
GetPath	Returns application path
GetPlatformFeatures	Returns information on the availability of some platform dependent features
GetPrinterInfo	Returns information on installed printers
GetPrintValues	Returns the names of all quantities specified in .PRINT controls in the most recent simulation
GetReadOnlyStatus	Retruns internal read-only status of specified schematic
GetRegistryClassesRootKeys	List sub keys under key in registry HKEY_CLASSES_ROOT root
GetSchematicFileVersion	Returns the file version for the schematic
GetSchematicTabs	Returns the IDs of the schematics.
GetSchematicVersion	Returns version information about the current schematic
GetSchemTitle	Returns the title of the current schematic
GetSelectedAnnotationText	Returns the text in the selected annotation
GetSelectedCurves	Returns array of curve id's for selected curves
GetSelectedGraphAnno	Return ID of selected graph annotation object
GetSelectedStyleNames	Returns the names of the styles used by the selected elements
GetSelectedYAxis	Returns id of selected Y-Axis
GetShortPathName	Returns short path name for path specified either as a long or short path
GetSimConfigLoc	Returns the location of the simulator's configuration information
GetSimetrixFile	Returns path name of user selected file
GetSimplisExitCode	Returns the application exit code for the most recent SIMPLIS run
GetSimulationErrors	Retrieves the error messages raised by the most recent simulation run
GetSimulationInfo	Returns information about the most recent simulation
GetSimulationSeeds	Returns the seeds used for the most recent run
GetSimulatorEvents	Returns list of events for most recent simulation
GetSimulatorMode	Returns the simulator mode of the current schematic
GetSimulatorOption	Returns the value of a simulator option as used by the most recent analysis
GetSimulatorOptionInfo	Returns type and default value of a simulator option setting
GetSimulatorOptions	Return list of simulator options
GetSimulatorStats	Returns statistical information about the most recent run
GetSimulatorStatus	Returns the current status of the simulator
GetSoaDefinitions	Returns all Safe Operating Area definitions specified in the most recent analysis
GetSoaMaxMinResults	Returns the maximum and minimum values reached for all SOA definitions
GetSoaOverloadResults	Returns the overload factor for each SOA definition
GetSoaResults	Returns the SOA results for the most recent simulation
GetSymbolArcInfo	Returns information on symbol editor arc
GetSymbolFiles	Returns full paths of all installed symbol library files
GetSymbolInfo	Returns information on symbol editor symbol
GetSymbolOrigin	Returns the location of the symbol editor's symbol origin point
GetSymbolPropertyInfo	Returns information about symbol editor symbol properties
GetSymbolPropertyNames	Returns symbol editor symbol property names
GetSymbols	Returns array of available schematic symbols
GetSystemInfo	Returns information about the user's system
GetTempFile	Creates a temporary file name
GetTextEditorText	Returns text in the selected text based editor
GetThreadTimes	Returns the execution times for each device thread for the most recent simulation
GetTimerInfo	Returns information about a timer object
GetTitleBlockInfo	Returns information about the selected schematic title block
GetToolButtons	Returns name and description for available tool buttons
GetUncPath	Returns UNC path of specified path
GetUserFile	Returns path name of user specified file. Supersedes
GetVecStepParameter	Returns parameter name associated with vector
GetVecStepVals	Returns parameter values associated with vector
GetWidgetInfo	Returns info about open views
GetWindowNames	Returns names of current SIMetrix windows
GetXAxis	Returns the id of the x-axis in the currently selected graph
GraphImageCapture	Opens Graph Image Capture dialog
GraphLimits	Returns x and y limits of selected graph
GroupDelay	Returns group delay of argument
Groups	Returns array of available groups
GuiType	Returns whether a GUI is enabled
Hash	Returns a `hash' value for the supplied string
HashAdd	Add items to a hash table
HashCreate	Create a hash table
HashDelete	Delete a hash table
HashSearch	Search hash table for an item
HasLogSpacing	Determines whether the supplied vector is logarithmically spaced
HasProperty	Determines whether a particular instance possesses a specified property.
HaveFeature	Detrmines whether a specified license feature is available
HaveInternalClipboardData	Returns the number of items in the specified internal clipboard
HierarchyHighlighting
HighlightedNets	Returns names for any wholly highlighted net names on the specified schematic
Histogram	Returns histogram of argument
Iff	Returns a specified value depending on the outcome of a test
IffV	Returns a specified value depending on the outcome of a test
IIR	Infinite Impulse Response digital filter
im	Returns imaginary part of argument
imag	Returns imaginary part of argument
InitRandom	Initialises the random number generator used for SIMPLIS Monte Carlo distribution functions
InputGraph	User Interface function. Input text for graph operation
InputSchem	User Interface function. Input text for schematic operation
Instances	Returns array of instances possessing specified property
InstNets	Returns array of net names for each pin of selected schematic instance
InstNets2	As InstNets but with more advanced features to identify instance
InstPins	Returns array of pin names for each pin of selected schematic instance
InstPoints	Returns location and orientation of specified instance
InstProps	Returns names of all properties owned by selected instance
integ	Returns integral of argument
Interp	Interpolates argument to specified number of evenly spaced points
IsComplex	Returns TRUE if argument is complex
IsComponent	Determines whether a schematic instance is a hierarchical component
IsDocumented	Returns whether the script command or function is documented
IsFileOfType	Returns TRUE if the filename given is of the type checked against
IsFullPath	Returns TRUE if the supplied path name is a full absolute path
IsImageFile	Tests if a file type is an image format.
IsModelFile	Determines if a file contains valid electrical models
IsNum	Returns TRUE if argument is numeric (real or complex)
IsOptionMigrateable	Determines if an option variable may be migrated in a version upgrade.
IsSameFile	Compares two paths and returns true (1) if they point to the same file
IsScript	Determines whether the supplied script name can be located
IsStr	Returns TRUE if argument is a string
IsTextEditor	Returns true if selected editor is a text editor
IsTextEditorModified	Returns true if the highlighted text editor is modified.
JoinStringArray	Concatenates two string arrays to return a single array
length	Returns number of elements in vector.
ListDirectory	Returns file names found in a directory matching a supplied wildcard spec
ListSchemProps	Returns the schematic properties
ln	Natural logarithm
LoadFile	Returns the contents of a text file as a vector
Locate	Locates value in a monotonic vector. Returns index.
log	Base 10 logarithm, same as
log10	Base 10 logarithm
mag	Magnitude (same as
magnitude	Magnitude (same as the function
MakeDir	Make a directory and result of operation
MakeLogicalPath	Converts a file system path to a symbolic path
MakeString	Create a string array with specified number of elements
ManageDataGroupsDialog	Open Manage Data Group dialog box
ManageMeasureDialog	Opens dialog box used to manage graph measurements.
max	Returns max of two vectors
maxidx	Returns index to maximum input value
Maxima	Returns locations of maxima of specified vector
Maximum	Returns most positive value in vector
mean	Returns statistical mean of all values in vector
Mean1	Returns mean of data in given range
MeasureDialog	Opens dialog for specifying graph measurements
MessageBox	Opens a dialog box with a message and user options
Mid	Returns substring of the given string
min	Returns min of two vectors
minidx	Returns index to minimum input value
Minima	Returns locations of minima of specified vector
Minimum	Returns most negative value in vector
MkVec	Returns an expression to access simulation vector data
MLSplineFit	Spline based fit to given data
MLVector	Creates a vector of consecutively increasing values.
ModelLibsChanged	Returns TRUE if any installed model paths have changed
Navigate	Returns path name of hierarchical block given root path and full component reference
NearestInst	Cross probe function. Returns nearest schematic instance to cursor
NetName	Cross probe function. Returns the net name of the nearest wire or instance pin.
NetNames	Returns array of all net names in selected schematic
NetWires	Return all wires on specified net
NewPassiveDialog	UI function to select passive component value and parameters
NewValueDialog	General purpose user input function. Opens a user configurable dialog box
norm	Returns argument scaled so that its largest value is unity.
NumberSelectedAnnotations	Returns number of selected annotations
NumDivisions	Returns number of divisions in a vector
NumElems	Returns number of elements in a vector
OpenEchoFile	Redirects the output of the Echo command
OpenFile	Opens a file and returns its handle. This may be used by the Echo command
OpenPDFPrinter	Sets up printing for PDF output
OpenPrinter	Starts a print session
OpenSchem	Opens a schematic and returns value indicating success or otherwise
OpenSchematic	Opens a schematic without displaying it. Returned ID useable by various functions and commands
Parse	Splits up the string supplied as argument 1 into substrings or tokens
ParseAnalysis	Opens the choose analysis dialog
ParseLaplace	Parses a Laplace expression to return array of denominator and numerator coefficients
ParseParameterString	Parses a string of name-value pairs and performs some specified action on them
ParseSimplisInit	Reads and parses the .init file created by a SIMPLIS run
PathEqual	Compares two path names with platform dependent case-sensitivity
PerCycleTiming	Returns a vector of ``Per Cycle'' Frequency, Period, Duty Cycle, On-Time, or Off-Time values.
PerCycleValue	Returns a vector of "Per Cycle" Minimum, Maximum, Mean, Peak-to-Peak, or RMS values.
ph	Returns phase of argument in degrees
phase	Returns phase of argument in degrees
phase_rad	Returns phase of argument in radians
PhysType	Returns the physical type of the argument
PinName	Cross probe function. Returns pin name nearest to cursor
PrepareSetComponentValue	Configures
Probe	Displays probe cursor in schematic and waits for mouse click
ProcessingAccelerator	Detects if the current script was called by an accelerator key
ProcessingDragAndDrop	Detects if the current script was called by a drag and drop operation
ProcessingGuiAction	Detects if the current script was called by a GUI action
Progress	UI function, opens progress bar
PropFlags	Returns the attribute flags of a schematic property
PropFlags2	Returns the attribute flags of a schematic property
PropFlagsAll	Returns selected property flags for all selected elements with optional filtering
PropFlagsAnnotations	Returns selected property flags for all selected annotations with optional filtering
PropFlagsWires	Returns selected property flags for all selected wires with optional filtering
PropOverrideStyle	Returns override style of selected property
PropValue	Returns value of specified property for selected instance
PropValues	Returns array of property values
PropValues2	As PropValues but with rearranged arguments
PropValuesAll	Returns selected property values for all selected elements with optional filtering
PropValuesAnnotations	Returns selected property values for all selected annotations with optional filtering
PropValuesWires	Returns selected property values for all selected wires with optional filtering
PutEnvVar	Write an environment variable
PWLDialog	Opens a dialog box designed for editing piece wise linear sources
QueryData	Filters a list of data items according to search criteria
RadioSelect	User interface function. Returns user selection of up to 5 radio buttons
Range	Returns range of vector (accepts, real, complex and string)
re	Returns real part of argument
ReadClipboard	Returns text contents of the windows clipboard
ReadConfigCollection	Returns the contents of an entire section in the configuration file
ReadConfigSetting	Reads a configuration setting
ReadF11Options	Read .OPTIONS line in the F11 window
ReadFile	Reads text file and returns contents as an array of strings
ReadIniKey	Reads a key in an ``INI'' file
ReadRegSetting	Reads a string setting from the windows registry
ReadSchemProp	Returns value of schematic window property value.
ReadTextEditorProp	Reads a text editor property
real	Returns real part of argument
Ref	Returns reference of argument
RefName	Returns the name of the arguments reference vector
RelativePath	Returns a relative path name given a full path and a reference path
RemapDevice	Map SIMetrix simulator device to model name and level number
RemoveConfigCollection	Removes one or more entries from a configuration file collection
RemoveModelFile	Uninstalls a model path
RemoveSymbolFiles	Removes a symbol file or set of symbol files from the symbol library
ResolveGraphTemplate	Evaluate template string used by graph object
ResolveTemplate	Evaluate template string
RestartTranDialog	UI function, opens restart transient dialog
Rms	Returns accumulative RMS value of argument
RMS1	Returns RMS of argument over specified range
rnd	Returns random number
RootSumOfSquares	Returns root sum of squares of argument over specified range
rt	Evaluate template string
SaveSpecialDialog	Opens the dialog used by the schematic's Save Special... menu
Scan	Splits a character delimited string into its components.
ScriptName	Return name of currently executing script
Search	Search for a string in a list of strings
SearchModels	Special purpose used by library installation. Returns pathnames of SPICE compatible model files
Seconds	Returns the number of seconds elapsed since January 1, 1970
Select2Dialog	Displays a dialog offering two lists
SelectAnalysis	Opens choose analysis dialog box. Returns value according to how box closed
SelectColourDialog	UI function, opens colour selection dialog
SelectColumns	Analyses an array of character delimited strings and returns selected values.
SelectCount	Returns number of selected items on schematic
SelectDevice	Special function forms part of parts browser system. Takes catalog data as arguments and opens dialog box to select a device.
SelectDialog	User interface function. Allows selection of one or more items from list
SelectedProperties	Returns information about selected properties
SelectedStyleInfo	Returns style information for the selected element
SelectedWires	Returns handles to selected wires on schematic
SelectFontDialog	UI function, opens select font dialog
SelectRows	Analyses an array of character delimited strings and returns selected values.
SelectSimplisAnalysis	Opens SIMPLIS choose analysis dialog box
SelectSymbolDialog	Opens a dialog box allowing the user to select a schematic symbol from the symbol library
SelGraph	Returns id of selected graph.
SelSchem	Returns TRUE if at least one schematic is open.
SetComponentValue	Special function to set or get a component value or parameter
SetInstanceParamValue	Set an instance parameter during a script-based multi-step analysis
SetModelParamValue	Set a model parameter during a script-based multi-step analysis
SetPropertyStyles	Sets styles as property styles
SetReadOnlyStatus	Sets read-only/writeable status of specified schematic
Shell	Runs an external program and returns its exit code
ShellExecute	Performs an operation on a windows registered file
sign	Returns sign of argument
SimetrixFileInfo	Returns information about a SIMetrix file
SIMPLISRunStatus	Tests if a SIMPLIS simulation is running
SIMPLISSearchIdx	Searches input string array for a test string, returning the indices into input array array where the test string matches.
SimulationHasErrors	Determines success of most recent simulation
sin	Sine (radians)
sin_deg	Sine (degrees)
sinh	Hyperbolic sine (radians)
Sleep	Executes a timed delay
Sort	Performs alphanumeric sort on argument.
SortIdx	Sorts any vector and returns index order
SourceDialog	User Interface function. Opens source dialog box for specifying of voltage and current source. Returns string with user selected values
SplitPath	Splits file system path into its components
SplitString	Splits string into parts according to single token
SprintfNumber	Returns a formatted string
sqrt	Square root
Str	Converts argument to string
StringLength	Returns the number of characters in the supplied string.
StringStartsWith	Checks whether a string starts with another string.
StrStr	Locates a sub string within a string
StyleInfo	Returns style information
StyleLineTypes	Returns list of possible style line types
StyleNames	Returns a list of style names
SubstChar	Substitutes characters in string
SubstString	Replaces a substring in a string, case sensitive
sum	Sums the arguments
SumNoise	Returns root sum of squares of argument over specified range
SupportedReadFormats	Returns names of image formats types supported for display in SIMetrix windows such as schematics.
SupportedWriteFormats	Returns names of image formats types that SIMetrix can create for graphical windows such as schematics and graphs.
SymbolInfoDialog	Returns name of schematic symbol
SymbolLibraryManagerDialog	Opens the Symbol Library Manager dialog box
SymbolName	Returns symbol name of specified instance
SymbolNames	Returns symbol names of schematic instances
SymbolPinOrder	Set and/or return pin order of symbol editor symbol
SymbolPinPoints	Returns the location of specified pin
SystemValue	Returns the value of a system defined variable
SystemValuePath	Returns the value of a system defined variable that accesses a file system path
SystemWidgetExistsInSelectedWindow	States whether particular system view is in the highlighted window
TableDialog	Displays a spreadsheet style table to allow the user to enter tabular data
TableEditor	Displays a table of combo boxes to allow select tabular data
tan	Tangent (radians)
tan_deg	Tangent (degrees)
tanh	Hyperbolic tangent (radians)
TemplateGetPropValue	Function returns the value of a property. For use in template scripts only
TemplateResolve	Resolve TEMPLATE value. For use in template scripts only
TextEditorHasComments	Returns whether the editor supports comments
ThdWeight	Returns a vector of weighting coefficients used to weight the harmonic coefficients before making a THD measurement.
TickCount	Returns a time in seconds suitable for timing measurement
Time	Return system time as string
ToLower	Converts a string to all lower case
TransformerDialog	Special function to select transformer characteristics
TranslateLogicalPath	Converts symbolic path to a physical path
TreeListDialog	General purpose UI function. Open dialog box with tree list control
True	Returns 1 if vector exists and is nonzero
Truncate	Returns vector that is a sub range of supplied vector
TwoFileSelectionDialog	General purpose file dialog with two file entries and an option third description entry
UD	Alias of
Unif	Returns random number with uniform distribution
Units	Returns physical units of argument
unitvec	Returns vector of specified length whose elements are all 1
UpDownDialog	General purpose UI function. Opens dialog with up-down list to allow rearranging order
UserParametersDialog	UI function, opens dialog allowing editing of user parameter values
Val	Converts argument to value
ValueDialog	User interface function. Opens dialog with up to 10 boxes for entering numeric values. Return array of user selected values
Vec	Returns data for named vector. (Allows access to vectors with invalid names)
vector	Returns vector of specified length with each element equal to its index
VectorsInGroup	Returns array of variable names belonging to specified group
VersionInfo	Returns version information about running copy of SIMetrix
ViewFormattedText	View HTML formatted text
WC	Returns random number with worst case distribution
WirePoints	Returns location of specified wire
Wires	Return all wires in schematic
WM_CanRevertToSaved	Returns whether chosen editor has a revertable saved state.
WM_GetCentralWidgetGeometry	Returns window geometry information
WM_GetContentWidgetNames	Returns content widget names
WM_GetContentWidgetSessionInfo	Returns widget session information
WM_GetContentWidgetsLayout	Returns layout information
WM_GetContentWidgetTypes	Returns the workspace view types in a particular window
WM_GetCurrentWindowName	Returns name of highlighted window
WM_GetNumberModifiedEditors	Returns number of editors that are modified in all windows
WM_GetPrimaryWindowName	Returns the name of the primary window
WM_GetSystemWidgetSessionInfo	Returns widget session information
WM_GetSystemWidgetsLayout	Returns layout information
WM_GetWindowGeometry	Returns window geometry
WM_GetWindowNames	Returns the names of all windows
WM_NumberContentWidgets	Returns the number of content widgets in use
WM_NumberSystemWidgets	Returns the number of system widgets in use
WriteConfigSetting	Writes a configuration setting
WriteF11Lines	Writes lines directly to the F11 window overwriting any existing lines
WriteF11Options	Write SIMetrix simulator options to the F11 window.
WriteIniKey	Writes a key value to an `INI' file
WriteRawData	Writes data to the specified file in a SPICE3 raw file compatible format
WriteRegSetting	Writes a string value to the windows registry
WriteSchemProp	Write schematic window property value
XCursor	Returns x location of graph cursor
XDatum	Returns x location of graph reference cursor
XFromY	Returns array of values specifying horizontal locations where specified vector crosses given y value
XMLCountElements	Returns the number of elements of a particular type
XMLGetAttribute	Returns the attribute value for given name at the current focus element
XMLGetElements	Lists elements at the current focus level
XMLGetText	Returns the text for the current focus element
XMLToString	Returns the XML document as a string
XY	Creates an XY Vector from two separate vectors
YCursor	Returns y location of graph cursor
YDatum	Returns x location of graph reference cursor
YFromX	Returns array of values specifying the vertical value of the specified vector at the given x value


◄ Unsupported Functions and Commands		Functions by Application ▶