All Frameworks Class Hierarchy This Framework Previous Indexes
ObjectSpecsModeler Interface CATOsmSUHandler
CATOsmSUHandler
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATOsmSUHandler
Provides access to a startup stored in catalogs.
CATIContainer *piRootContainer;
...
CATOsmSUHandler CAAOsmNovel("CAAOsmNovel", "CAAOsmClientId", "CAAOsmCatalogSU.CATfct" );
CATISpecObject_var spnew_inst;
rc = CAAOsmNovel.Instanciate(spnew_inst, piRootContainer,"CAAOsmNovel1");
if( FAILED(rc) )
...
Method Index
- o
Instanciate(CATISpecObject_var&,CATIContainer*,CATUnicodeString&)
- Creates a new instance of the StartUp.
- o
IsValid()
- Checks that the StartUp specified by CATOsmSUHandler constructor is valid.
- o
RetrieveSU(CATISpecObject_var&)
- Retrieves the startup specified by CATOsmSUHandler constructor.
Methods
o Instanciate
-
Creates a new instance of the StartUp.
Role:From a StartUp, we can create objects inheriting both the type, the
values and the attributes of the StartUp. These new objects originating
from the StartUp are called instances.
Instances can be created either from a StartUp or from an instance.The
object from which an instance originates is called the reference.
- Parameters:
-
- oObject
- The returned instance.
- iContainer
- The container in which the instance will be created.
- iName
- The name to be given to the instance.
if NULL, the instance will have the same name as the StartUp's.
- S_OK call was successful
- E_ACCESSDENIED incorrect catalog or invalid client id
- E_INVALIDARG if the container is NULL
- E_FAIL invalid startup or cannot instanciate object
o IsValid
-
Checks that the StartUp specified by CATOsmSUHandler constructor is valid.
- Returns:
- HRESULT convention S_OK,E_ACCESSDENIED,E_FAIL *
- S_OK call was successful
- E_ACCESSDENIED incorrect catalog or invalid client id
- E_FAIL invalid startup
o RetrieveSU
public HRESULT RetrieveSU( | CATISpecObject_var& | oStartup) |
-
Retrieves the startup specified by CATOsmSUHandler constructor.
- Parameters:
-
- oStartup
- The startup
- S_OK call was successful
- E_ACCESSDENIED incorrect catalog or invalid client id
- E_FAIL invalid startup
This object is included in the file: CATOsmSUHandler.h
If needed, your Imakefile.mk should include the module: CATObjectSpecsModeler