PLMFolderInterfaces PLMFolderServices

Usage: you must use this class as is. You should never derive it.


public class PLMFolderServices

Class providing static methods to manipulate Folders.


Method Index


o GetFolder(CATIAdpPLMIdentificator*,PLMIFolder*&,CATOmbLifeCycleRootsBag&)
Gets Folder either from database, either from session.
o GetFolder(CATListPtrCATIAdpPLMIdentificator&,CATListPtrPLMIFolder&,CATOmbLifeCycleRootsBag&)
Gets a list of Folders either from database, either from session.

Methods


o GetFolder
public static GetFolder( iFolderIdentifier,
oFolder,
ioBag)
Gets Folder either from database, either from session. This method can be used for Root Folders or SubFolders.
Parameters:
iFolderIdentifier
The identifier of Folder to open or to fetch.
oFolder
The returned Folder. This object will need to be put into a bag
for correct lifecycle management.
ioBag
The Bag. Do not forget to RemoveAll()
Returns:
  • S_OK if the Folder was successfully opened.
  • E_FAIL otherwise.
o GetFolder
public static GetFolder( iFolderIdentifiers,
oFolders,
ioBag)
Gets a list of Folders either from database, either from session. This method can be used for Root Folders or SubFolders.
Parameters:
iFolderIdentifiers
The identifier of Folders to open or to fetch.
oFolders
The returned Folders. This objects will need to be put into a bag
for correct lifecycle management.
ioBag
The Bag. Do not forget to RemoveAll()
Returns:
  • S_OK if the Folders were successfully opened.
  • E_FAIL otherwise. If one fails, the whole list fails.

This object is included in the file: PLMFolderServices.h
If needed, your Imakefile.mk should include the module: PLMFolderItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.