Difference between revisions of "CAEngine::GetObjectByName"
(Marked this version for translation) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[CAEngine | + | [[Category:ADE User Guide]] |
| + | [[ADE User Guide]] > [[ADE Server Class Reference]] > [[CAEngine]] | ||
| + | <languages /> | ||
| + | <translate> | ||
| − | = GetObjectByName(objName) = | + | = GetObjectByName(objName) = <!--T:1--> |
= Get(objName) = | = Get(objName) = | ||
| + | <!--T:2--> | ||
Either of these synonymous methods return an object of type [[CAObject]] for an existing Analytica object with identifier ''«objName»''. | Either of these synonymous methods return an object of type [[CAObject]] for an existing Analytica object with identifier ''«objName»''. | ||
| + | <!--T:3--> | ||
This is the primary method used for obtaining instances of Analytica objects, and hence is one of the most commonly used methods in ADE. Because it is so common, the '''Get''' synonym is provided. | This is the primary method used for obtaining instances of Analytica objects, and hence is one of the most commonly used methods in ADE. Because it is so common, the '''Get''' synonym is provided. | ||
| − | = Parameters = | + | = Parameters = <!--T:4--> |
| + | <!--T:5--> | ||
; objName : string - the Analytica identifier, case insensitive | ; objName : string - the Analytica identifier, case insensitive | ||
| − | = Return value = | + | = Return value = <!--T:6--> |
| + | <!--T:7--> | ||
[[CAObject]] | [[CAObject]] | ||
| − | = Example usage = | + | = Example usage = <!--T:8--> |
// C# | // C# | ||
| Line 24: | Line 31: | ||
| − | = API errors = | + | = API errors = <!--T:9--> |
| + | <!--T:10--> | ||
* 41 - "invalid name for object" | * 41 - "invalid name for object" | ||
| + | </translate> | ||
Latest revision as of 18:40, 15 June 2015
ADE User Guide > ADE Server Class Reference > CAEngine
GetObjectByName(objName)
Get(objName)
Either of these synonymous methods return an object of type CAObject for an existing Analytica object with identifier «objName».
This is the primary method used for obtaining instances of Analytica objects, and hence is one of the most commonly used methods in ADE. Because it is so common, the Get synonym is provided.
Parameters
- objName
- string - the Analytica identifier, case insensitive
Return value
Example usage
// C#
CAObject obj;
obj = ade.GetObjectByName("Monthly_revenue");
obj = ade.Get("Monthly_revenue"); // alternate equiv. form
API errors
- 41 - "invalid name for object"
Comments
Enable comment auto-refresher