All Frameworks Class Hierarchy This Framework Next Indexes
ObjectSpecsModeler Class CATOsmExtensionServices
CATOsmExtensionServices
Usage: you must use this class as is. You should never derive it.
public class CATOsmExtensionServices
Services to manage former extension features and user extensions.
Role: Class of service to activate all former extension features and retrieve user
extensions associated to a base feature defined in a CATfct catalog.
If you have to manage existing documents containing former extension features you have to use the
CATActivateExtensions services to activate your extensions.
Activation is not needed for new extension features created with CATIOsmExtendable . User extensions are automatically created and added on a base feature when it is created.
This is not a part of the
CATIOsmExtendable interface as it is not neccessary to have the base feature itself its type is sufficient to retrieve this informations.
Method Index
- o
CATActivateExtensions(CATDocument*,char*)
- Uses only to activate former extension features.
- o
CATActivateExtensions(CATIContainer*)
- Uses only to activate former extension features.
- o
CATOsmListUserExtensionsFromCatalog(CATUnicodeString*,CATListValCATUnicodeString**,CATListValCATUnicodeString**)
- Service to retrieve user extensions associated to a base feature and all its supertypes.
- o
GetExtensionIdentifier(CATBaseUnknown*,CATUuid&,CATUnicodeString&)
- Returns the invariant identifier of an extension
Methods
o CATActivateExtensions
-
Uses only to activate former extension features.
Activate all extensions contained in an applicative container of the specified document.This container should have been initialized.
- Parameters:
-
- iDocument
- The document containing the initialized applicative container
- iAppId
- The name of the initialized applicative container containing the extensions to be activated
- Returns:
- HRESULT S_OK
The activation succeeded
E_FAIL
No container found or activation error
o CATActivateExtensions
-
Uses only to activate former extension features.
Activate all extensions contained in an applicative container. This container should have been initialized.
- Parameters:
-
- iAppliCont
- The initialized applicative container containing the extensions to be activated
- Returns:
- HRESULT S_OK
The listing succeeded
E_FAIL
No container found or activation error
o CATOsmListUserExtensionsFromCatalog
-
Service to retrieve user extensions associated to a base feature and all its supertypes.
Role: Retrieve user extensions associated to a base feature defined in a CATfct catalog.
User extensions are automatically created and added on a base feature when it is created.
This is not a part of the
CATIOsmExtendable interface as it is not neccessary to have the base feature itself its type is sufficient to retrieve this informations.
CATOsmListUserExtensionsFromCatalog:
Given the type of a base feature in a CATfct Catalog, this method will list associated extensions (directly
or through its supertypes) and the associated containers
- Parameters:
-
- iBaseFeatureType
- The pointer on Base Feature Type
- pListOfExtensions
- The list of extensions
- pListOfAssociatedContainers
- The list of Associated Containers
- Returns:
- HRESULT S_OK
The listing succeeded
E_FAIL
No user extensions in catalog
E_INVALIDARG
iBaseFeatureType is NULL
E_UNEXPECTED
Problem in listing user extensions
o GetExtensionIdentifier
-
Returns the invariant identifier of an extension
- Parameters:
-
- ipExtension
- The extension asked its identifier
- oIdentifier
- The returned identifier
- iClientId
- The catalog's client identifier that the extension comes from
- Returns:
- HRESULT S_OK
Identifier returned
E_INVALIDARG
The passed in pointer is not an extension
E_ACCESSDENIED
The passed in iClientId is not the one of the extension's catalog
E_FAIL
Non documented error
This object is included in the file: CATOsmExtensionServices.h
If needed, your Imakefile.mk should include the module: CATObjectSpecsModeler