Difference between revisions of "CAEngine::AddModule"

Latest revision as of 18:55, 14 January 2016

ADE User Guide > ADE Server Class Reference > CAEngine

Other languages:

English • ‎中文

AddModule(fileName, merge)

Adds a module from file «fileName» into the CurrentModule. The «merge» parameter currently has no effect and should be set to True. The path is interpreted relative to the CurrentModelDirectory.

Parameters

«fileName»: string
«merge»: Boolean

Return value

ModuleName: string

Usage

string modName = ade.AddModule ("C:\MYMOD\MYMOD.ANA", True);

API errors

39 – “Module could not be found”

@@ Line 4: / Line 4: @@
 <translate>
-= AddModule(fileName,merge) = <!--T:1-->
+== AddModule(fileName, merge) == <!--T:1-->
 <!--T:2-->
-Adds a module from file «fileName» into the [[CurrentModule]]. The merge parameter currently has
+Adds a module from file «fileName» into the [[CurrentModule]]. The «merge» parameter currently has no effect and should be set to <code>True</code>.  The path is interpreted relative to the [[CurrentModelDirectory]].
-no effect and should be set to True.  The path is interpreted relative to the [[CurrentModelDirectory]].
-= Parameters = <!--T:3-->
+== Parameters == <!--T:3-->
 <!--T:4-->
-;fileName:string
+; «fileName»: string
-;merge:Boolean
+; «merge»: Boolean
-= Return value = <!--T:5-->
+== Return value == <!--T:5-->
 <!--T:6-->
-ModuleName – string
+; ModuleName: string
-= Usage = <!--T:7-->
+== Usage == <!--T:7-->
- <!--T:8-->
+<!--T:8-->
-string modName = ade.AddModule ("C:\MYMOD\MYMOD.ANA", True);
+<code>string modName = ade.AddModule ("C:\MYMOD\MYMOD.ANA", True);</code>
-= API errors = <!--T:9-->
+== API errors == <!--T:9-->
 <!--T:10-->
 * 39 – “Module could not be found”
 </translate>