All Frameworks Class Hierarchy This Framework Indexes
ENOVFLDManager Interface ENOVIFolderManager
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMInterfaces.CATIAVPMTPRootDesktop
|
+---ENOVIFolderManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIFolderManager
Interface for ENOVIFolderManager.
Role: This interface defines methods in ENOVIFolderManager.
Method Index
- o
CreateFolder(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&)
- Creates a folder.
- o
CreateFolder(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATIVpmFactoryObject_var&)
- Creates a folder version.
- o
DeleteFolder(CATIVpmFactoryObject_var&)
- Deletes a folder.
- o
DeleteFolderVer(CATIVpmFactoryObject_var&)
- Deletes a folder version.
- o
FindFolder(CATUnicodeString,CATLISTV(CATIAVPMFolderMaster_var)&)
- Retrieves folders that match the input folder ID.
- o
FindFolderWithVID(CATUnicodeString&,CATIVpmFactoryObject_var&)
- Retrieves the folder that matches the input folder ID exactly (with no wildcard char).
Methods
o CreateFolder
-
Creates a folder.
- Parameters:
-
- iFolderID
- The folder ID
- iFolderName
- The folder name
- iFolderDescription
- The folder description
- iFolderType
- The folder type
- oFolder
- The folder object
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o CreateFolder
-
Creates a folder version.
- Parameters:
-
- iFolderID
- The folder ID
- iFolderName
- The folder name
- iFolderDescription
- The folder description
- oFolderVersion
- The folder version object
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o DeleteFolder
public virtual HRESULT DeleteFolder( | const CATIVpmFactoryObject_var& | iFolder) = 0 |
-
Deletes a folder.
- Parameters:
-
- iFolder
- The folder
o DeleteFolderVer
public virtual HRESULT DeleteFolderVer( | CATIVpmFactoryObject_var& | iFolderVersion)=0 |
-
Deletes a folder version.
- Parameters:
-
- iFolderVersio
- The Folder version
o FindFolder
public virtual HRESULT FindFolder( | const CATUnicodeString | iFolderID, |
| CATLISTV(CATIAVPMFolderMaster_var)& | oFolderMasters)=0 |
-
Retrieves folders that match the input folder ID.
- Parameters:
-
- iFolderID
- The folder ID
- oFolderMasters
- The list of folder master objects
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o FindFolderWithVID
public virtual HRESULT FindFolderWithVID( | const CATUnicodeString& | iFolderV_ID, |
| CATIVpmFactoryObject_var& | oFolderMaster)=0 |
-
Retrieves the folder that matches the input folder ID exactly (with no wildcard char).
- Parameters:
-
- iFolderID
- The folder ID
- oFolderMaster
- The folder master objects
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIFolderManager.h
If needed, your Imakefile.mk should include the module: fldmanager