BasicNoUIObjModuleInstance Method

public Module? ModuleInstance(
	string fileName,
	bool createNew
)

Public Function ModuleInstance ( 
	fileName As String,
	createNew As Boolean
) As Module

public:
virtual Module^ ModuleInstance(
	String^ fileName, 
	bool createNew
) sealed

Parameters

fileName  String

Get an object for this module. The filename string consists of two parts, each of which is optional:

[modulepath|][param]

If this modulepath is omitted, use the value of the FileName property as the file name.

createNew  Boolean

Only False is supported at this time (2025-01-24). If this is True then a new instance is created. (Only class or object modules can create new instances.) If this is False, the default object associated with the module is returned.

Return Value

Implements

All Public declarations in the module are available only through the returned object.

A module that isn't currently loaded by LoadModule allows for managing the state of the instance with the Module.State method. When the module instance if first created it already has a state named "" which is the selected state. The host application can create and select additional states which allow the Module instance to be used with different contexts. (State is the value of all the Macro and Module variables.)

Macro/Module Paths

Macro/module paths are typically file paths. However, it is sometimes useful to work with macros/modules that are not stored as files. A macro/module path is of the form: [*[*]]path[*]

Part	Description
'*'	Paths that being with '*' are non-file system macro/modules. The application provides the methods for reading and writing these files. Paths that begin and end with '*' are hidden from the IDE. User's can't step into or otherwise inspect the contents.
'**'	Paths that begin with '**' are non-file system modules. The application provides the methods for reading and writing these files. Running an event-driven module loads it using LoadModule.
path	This is the identity of the macro/module.

Reference