Run(object)

Add a file to the System folder of Code Builder's Origin C Workspace. After successfully adding the file compile and link it.

General mechanism for tool launching. OGOName is the tool OGO file name. DLLObject is the object (existing in an external DLL) that contains source values for the tool sub-objects. (For a full discussion of "source" and tool sub-objects, see the draw.set() method.)

The run.dialog() method is equivalent to the following script:

 
dotool -w OGOName; 
run.section(OGSName,INIT); 
DLLObject.reset(); 
draw.set(OGOName,DLLObject);

(Where the OGSName is named the same as OGOName.)

The run.dialog() method returns 0 if there is no error. It returns 1 if there is an error.

Execute the specified LabTalk script file. This is the preferred mechanism for running older user-defined script files without sections (versus using the run command). If the file has an OGS extension, then the extension is optional. If the file is located in your User Files Folder then the path is optional otherwise you must specify the full path.

Load and compile an Origin C function or workspace with optional bit arguments.

The err return value:

• If err = 0, indicates success. Either myFile is already loaded in the current workspace or it is loaded from a *.C file and compiled and linked successfully.
• If err = 1, myFile was not found.
• If err = 2, myFile was found and loaded into the current workspace, but the compiling or linking failed.

The myFile argument:

• The myFile can be either a workspace file (*.OCW) or a source file (*.C, *.CPP). If myFile is a workspace file, Origin checks each source file in the workspace file to see whether or not it is already loaded. If myFile is a source file, Origin checks to see if it is already loaded.
• In either case, if a source file is not already loaded then Origin adds it to the Temporary folder in the Code Builder workspace. When Origin is finished checking, it builds the Code Builder workspace. Files added to the Temporary folder of the Code Builder workspace are removed from the workspace when you close Code Builder or when you open a new or existing workspace file. Files can also be programmatically removed from the Temporary folder using the LabTalk run -cr <filename> command.
• You must surround myFile with quotation marks ("myFile").
• If no file extension is included, myFile is assumed to be a source file (*.C).
• If myFile has a full path, then it is used as is. If a path is not specified, Origin assumes that myFile is located in the \OriginC subfolder.
• The file name myFile supports wildcards.
  

The option argument:
Note: Options 1,2,4 and 8 are for internal use and are not recommended.

• 1 - Add file to Workspace User folder, but not Temporary Folder.
• 2 - Loads, compiles, and links the file that is not already compiled and linked; otherwise does nothing.
• 4 - Disable adding internal.c to the Workspace (Otherwise added by default).
• 8 - Disable linking. Method of suspending linking until all files are loaded (See example).
• 16 - Load all dependent Origin C files by scanning for .h files in the OC file being loaded.
• 2048 - Add file to the AutoLoad folder.

These are bit values and can be combined using the bit wise OR operator |. If option is not specified then zero is used.

run.python(arg, [option])

Minimum Origin Version Required: 2015 SR0

Execute Python statement(s) or files or evaluate Python expression(s), the arg should be a string variable including the Python statement, or file name and path, or Python evaluation, depending on the option. You can view the examples in the Run Python section below for sample usage.

• option = 0 (default), execute Python command

  In this case, arg should be the Python statement(s) and this is equivalent to the run -py command.

• option = 1, evaluate Python expression

  In this case, arg should be the Python expression and this is equivalent to the run -pye command.

• option = 2, execute Python file

  In this case, arg should be the path and name of the .py file and this is equivalent to the run -pyf command.

• option = 16, suppress output

  In this case, nothing will be output after execution

• option = 32 or 33, set the file path

  In this case, the path will be used when run.python(PythonFile, 2) when the full path of the file is not specified.

Execute the named section of the specified LabTalk script file. You can specify a path in fileName. If no path is specified, Origin first looks in the location of the open project, then the user files path, then the path to the Origin application file. Script file sections are separated by [section names]. For example, [Graph]. This method can pass up to five arguments to a section. Arguments in the script can be referred to using the temporary string variables:  %1, %2, %3, %4, and %5. Note: When filename is not included, the current running script file is assumed. For example:

run.section( ,Init);

executes a subroutine Sub1 which is included in the currently running script file. This is a useful way to make a modular structure within a script file.