PLMFolderInterfaces Interface PLMIRootFolderFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface PLMIRootFolderFactory
Interface representing Root Folder Factory.
Role:This interface is used to create or delete root folders.
Method Index
- o
CreateRootFolder(CATIType_var,CATListValCATICkeParm_var&,PLMIFolder*&)
- Creates a Root Folder.
- o
CreateRootFolder(CATIAdpEnvironment*,CATListValCATICkeParm_var&,PLMIFolder*&)
-
- o
DeleteRootFolder(PLMIFolder*)
- Deletes a Root Folder.
- o
RootFolderCreation(CATIType_var,CATListValCATICkeParm_var&,PLMIFolder*&)
- Creates a Root Folder.
- o
RootFolderCreation(CATIAdpEnvironment*,CATListValCATICkeParm_var&,PLMIFolder*&)
- Creates a Root Folder.
Methods
o CreateRootFolder
| public virtual CreateRootFolder( | | lType, |
| | iAttrList, |
| | oRootFolder) |
-
Creates a Root Folder.
- Parameters:
-
- lType
- Type to provide for new Folder.
- iAttrList
- All Public writable root folder attributes. This list must contain at least all mandatory attributes and one of the Identifier Set.
- oRootFolder
- The newly created Root Folder.
- Returns:
-
- S_OK if the Root Folder was successfully created.
- E_FAIL otherwise.
o CreateRootFolder
| public virtual CreateRootFolder( | | iEnv, |
| | iAttrList, |
| | oRootFolder) |
-
- Deprecated:
- R211 Use the
method Creates a Root Folder.
- Parameters:
-
- iEnv
- The customization of the new root folder will be the authoring customisation defined for the Root Folder inside the input PLM environment.
The future sub folders will all be created with the same Environment.
- iAttrList
- All Public writable root folder attributes. This list must contain at least all mandatory attributes and one of the Identifier Set.
- oRootFolder
- The newly created Root Folder.
- Returns:
-
- S_OK if the Root Folder was successfully created.
- E_FAIL otherwise.
o DeleteRootFolder
| public virtual DeleteRootFolder( | | iRootFolder) |
-
Deletes a Root Folder.
- Parameters:
-
- iRootFolder
- The Root Folder to delete.
- Returns:
-
- S_OK if the Root Folder was successfully deleted.
- E_INVALIDARG : iRootFolder is not a Root Folder.
- E_FAIL otherwise.
o RootFolderCreation
| public virtual RootFolderCreation( | | lType, |
| | iAttrList, |
| | oRootFolder) |
-
Creates a Root Folder.
This API invokes the PLMIdentificationInitialization Business Logic to initialize attributes on the created Root Folder, then attribute values are set with iAttrList.
- Parameters:
-
- lType
- Folder will be created with this Type.
- iAttrList
- List of attributes to set. Optional (can be NULL).
This list should not contain any attributes relative to customization.
- oRootFolder
- The newly created Root Folder.
- Returns:
-
- S_OK if the Root Folder was successfully created.
- E_FAIL otherwise.
o RootFolderCreation
| public virtual RootFolderCreation( | | iEnv, |
| | iAttrList, |
| | oRootFolder) |
-
Creates a Root Folder.
This API invokes the PLMIdentificationInitialization Business Logic to initialize attributes on the created Root Folder, then attribute values are set with iAttrList.
- Parameters:
-
- iEnv
- The customization of the new root folder will be the authoring customization defined for the Root Folder inside the input PLM environment.
The future sub folders will all be created with the same Environment.
If the argument is NULL, the current environment is used.
- iAttrList
- List of attributes to set. Optional (can be NULL).
This list should not contain any attributes relative to customization.
- oRootFolder
- The newly created Root Folder.
- Returns:
-
- S_OK if the Root Folder was successfully created.
- E_FAIL otherwise.
This object is included in the file: PLMIRootFolderFactory.h
If needed, your Imakefile.mk should include the module: PLMFolderItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.