All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVFLDManager Interface 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,CATIVpmFactoryObject_var&)
Creates a folder version.
o CreateFolder(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&)
Creates a folder.
o DeleteFolderVer(CATIVpmFactoryObject_var&)
Deletes a folder version.
o DeleteFolder(CATIVpmFactoryObject_var&)
Deletes a folder.
o FindFolderWithVID(CATUnicodeString&,CATIVpmFactoryObject_var&)
Retrieves the folder that matches the input folder ID exactly (with no wildcard char).
o FindFolder(CATUnicodeString,CATLISTV(CATIAVPMFolderMaster_var)&)
Retrieves folders that match the input folder ID.

Methods


o CreateFolder
public virtual CreateFolder( const iFolderId,
const iFolderName,
const iFolderDescription,
oFolderVersion)
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 CreateFolder
public virtual CreateFolder( const iFolderId,
const iFolderName,
const iFolderDescription,
const iFolderType,
oFolder)
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 DeleteFolderVer
public virtual DeleteFolderVer( iFolderVersion)
Deletes a folder version.
Parameters:
iFolderVersio
The Folder version
o DeleteFolder
public virtual DeleteFolder( const iFolder)
Deletes a folder.
Parameters:
iFolder
The folder
o FindFolderWithVID
public virtual FindFolderWithVID( const iFolderV_ID,
oFolderMaster)
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.
o FindFolder
public virtual FindFolder( const iFolderID,
oFolderMasters)
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.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.