All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABOFolder
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVInterfaces.ENOVIABusinessObject
|
+---ENOVInterfaces.ENOVIABOVersionMaster
|
+---ENOVIABOFolder
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABOFolder
Interface to define a Folder as a Business Object.
Role : A Folder is a set of documents, and can be attached to any kind
of object. It is designed as a Business Object for coherence and to get benefit
of the server commands. As it is a kind of VersionMaster object, a Folder
is versionnable.
Method Index
- o
RemoveDocument(long)
- Removes the document located by its index within the list of documents attached to the current folder.
- o
get_DocumentCount(long&)
- Retrieves the number of documents attached to the current folder.
- o
get_ParentObject(long,ENOVIABusinessObject*&)
- Retrieves the object on which the current folder is linked, located by the index in the list of objects to which the folder is linked.
- o
get_ParentObjectCount(long&)
- Retrieves the number of objects on which the current folder is linked.
Methods
o RemoveDocument
-
Removes the document located by its index within the list of documents attached to the current folder.
- Parameters:
-
- iIndex
- The index of the document to remove. It must be between 1 and oNbDocuments (given by
get_DocumentCount()
).
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_DocumentCount
-
Retrieves the number of documents attached to the current folder.
- Parameters:
-
- oNbDocuments
- Number of attached documents.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentObject
-
Retrieves the object on which the current folder is linked, located by the index in the list of objects to which the folder is linked.
- Parameters:
-
- iIndex
- The index in the list, must be between 1 and oNbParentObjects, given by
get_ParentObjectCount()
.
- oParentObject
- The parent object to retrieve.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentObjectCount
-
Retrieves the number of objects on which the current folder is linked.
- Parameters:
-
- oNbParentObjects
- Number of parent objects.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIABOFolder.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces