All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATPLMDictionary Interface VPMIDicMgr

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VPMIDicMgr
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface VPMIDicMgr

This class enables to manage all dictionary data.
role: Get VPMIDicMgr Interface each time you need to access to the dictionary using the global Function GetVPMIDicMgr


Method Index


o Init(int)
Initializes the Dictionary Manager.
o LoadPackage(CATString*,VPMDicPERSISTENT)
Loads a package.
o LoadPackage(CATString*,VPMDicPERSISTENT,VPMDicCONTENT)
Loads a package.
o LoadPackageFromDir(CATString*,CATString*,VPMDicPERSISTENT)
Loads a package from a given directory.
o LoadPackageFromDir(CATString*,CATString*,VPMDicPERSISTENT,VPMDicCONTENT)
Loads a package from a given directory.

Methods


o Init
public virtual HRESULT Init( const int iForadmin)=0
Initializes the Dictionary Manager. It must be called after the dictionary manager creation.
Parameters:
iForadmin
: Must always be set to 1
Returns:
S_OK, E_FAIL
o LoadPackage
public virtual HRESULT LoadPackage( const CATString* iPackageName,
const VPMDicPERSISTENT iMode)=0
Loads a package.
Parameters:
iPackageName
: Package name
iMode
:
o LoadPackage
public virtual HRESULT LoadPackage( const CATString* iPackageName,
const VPMDicPERSISTENT iMode,
const VPMDicCONTENT iContent)=0
Loads a package.
Parameters:
iPackageName
: Package name
iMode
: the only valid value is VPMDicFILE
iContent
: Package type of content (either VPMDicMETADATA, VPMDicTUNING, VPMDicRBODEF, or VPMDicRBOMAP)
o LoadPackageFromDir
public virtual HRESULT LoadPackageFromDir( const CATString* iDirName,
const CATString* iPackageName,
const VPMDicPERSISTENT iMode)=0
Loads a package from a given directory.
Parameters:
iDirName
: Directory containing the package
iPackageName
: Package name
iMode
: the only valid value is VPMDicFILE
o LoadPackageFromDir
public virtual HRESULT LoadPackageFromDir( const CATString* iDirName,
const CATString* iPackageName,
const VPMDicPERSISTENT iMode,
const VPMDicCONTENT iContent)=0
Loads a package from a given directory.
Parameters:
iDirName
: Directory containing the package
iPackageName
: Package name
iMode
: the only valid value is VPMDicFILE
iContent
: Package type of content (either VPMDicMETADATA, VPMDicTUNING, VPMDicRBODEF, or VPMDicRBOMAP)

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

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