Advanced Module Functions

(See also: Compilation and On-Line Modifications Functions)

ActiveCode              Returns the code value of the currently active statement in the given module instance.

AddModule               Adds a new module to an existing module and returns the module value of the newly created module.

AddParameter          Adds an existing variable as a module parameter and returns the number of parameters in the module.

AdjustCode              Adjusts the offsets and sizes of items stored in the .RUN file within the document file.

CalledInstances        Returns the object values of module instances that are called by a particular module.

CanEditDoc              Returns an indication as to whether or not the document for the given module can be edited.

ChildDocs                Gets the module values for the root and all descendent modules that match the conditions defined by the second parameter.

CleanModule            Removes the flag that marks when a module that has been changed programmatically.

ClearModule             Deletes the contents (all variables and states) of a module without removing the module itself.

CodeText                Will modify a source code file to replace the text for a given CodeValue with the new text.

ConstCount              Returns the number of constant parameters in a function.

CoverageSnapshot    Returns a data structure giving the module tree and the uncovered code list for a given source file.

CreateModule           Creates a new module and returns a pointer to it.

CrossReference        Returns a linked list of structures representing all references to a specified variable or module.

DeleteModule           Deletes a module from the system.

DLL                        Returns a value of a type specified by its parameter from a call to Microsoft Windows™ Dynamic Link Library using the C calling convention.

FileRootModule         Returns the module value of the root module that is defined by the document file that also contains the specified module.

FormalParms           Returns the number of formal parameters declared in a module.

GetModuleRefBox     Returns the outer reference box for any selectable (GUI) graphics in a module.

GetModuleText         Returns information about a module's document file.

GetOneParmText      Returns the text for one parameter of a function.

GetOverrides           Returns an array of overridden OpCodes in a module and the functions they call.

GetParameter          Retrieves a parameter from the code for the provided DAG

GetParmText           Returns the text for all parameters of a function.

GetTransitText         Returns information about the documentation of an action.

GetTransform          Returns the transform value applied to a graphic statement.

GetXformRefBox      Returns the reference box for any transform of a module.

GUITransform          Applies a graphical transformation to all graphics in a module and returns an indication when selected by a mouse button or the Enter key.

LoadDLL                  Loads a Microsoft Windows™ Dynamic Link Library.

LoadModule             Loads a module from its .RUN files and returns a pointer to that module.

MCSInstance            Returns the object value of a module called by another module.

MCSMod                  Returns the module value from a line of code that calls that particular module.

ModuleFileName       Returns the full path (including the drive letter) and file name of the document (.SRC) file of a module.

NParm                    Returns the number of parameters listed in a module instance.

NumParms              Returns the number of parameters of a statement.

OperationalChange    Executes on a PC that is attempting to make an operational database change.

OwningModule          Returns the module that contains a certain variable.

Parameter               Returns the value of (or may assign a value to) a parameter of a module.

ParentModule           Returns the parent module of a module.

ParentObject            Returns the parent object of a module.

ParmToBuff             Returns a buffer of formatted numeric parameter values.

Priority                   Sets the execution priority for a module, variable, or object.

PType                     Returns the actual type of parameter at an index.

RemoveParameter    Removes a parameter from a module's parameter list.

ResetParm              Resets parameters that become latched.

ResyncDoc              Sets the time and date for the document and .RUN files to the same.

RootTransform         Returns the object value that contains the root transform applied to the given module.

RunFileName            Returns the name of the .RUN file for a module, including the full drive and path.

RunFileVersion          Returns the minimum version of VTS that can read the .RUN files produced by the current version.

SaveModule             Saves a module definition to its *.RUN file.

SetCodeText            Modifies a source code file to replace the text for a given CodeValue with the new text.

SetModuleRefBox      Sets the reference box for a module.

SetModuleText         Sets the module's .SRC file information.

SetOneParmText      Sets the text for one parameter of a function.

SetOverride             Overrides OpCodes in a module temporarily setting them to call different functions.

SetParameter          Sets a parameter in a statement.

SetParmText            Sets the text for the parameters of a function.

StartTag                 Used to Start, Stop or Modify instances of a tag.

Untransform            Undoes a previous transform so that the module instance and everything it has called will not be transformed.

UpdateCoordinates    Update a graphic statement's coordinates to the document file in which it is specified.