CAEngine::GetObjectByName

Revision as of 22:50, 29 January 2010 by Lchrisman (talk | contribs)

<< class 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

CAObject

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


You are not allowed to post comments.