All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIPersistent

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

Usage: you can freely reimplement this interface.


interface CATIPersistent

Interface to manage persistency of document's data.
Note: if only these methods are needed, it is recommended to use CATDocumentServices services.

See also:
CATDocumentServices


Method Index


o Dirty()
Specifies if the document is modified or not.
o Load(char*,CATBoolean)
Loads a document.
o Load_B(SEQUENCE(octet),CATBoolean)
This method is not used.
o Save()
Saves document's data in the same file.
o SaveAs(char*,CATBoolean)
Saves document's data in another file.
o SaveAs_B(SEQUENCE(octet),CATBoolean)
This method is not used.

Methods


o Dirty
public virtual CATBoolean Dirty()=0
Specifies if the document is modified or not.
You should not use this method, but use the NeedToBeSaved method of the CATIxPDMItem interface instead.
o Load
public virtual void Load(char* iStoragePrintableName,
CATBoolean iReadOnly)=0
Loads a document.
Note: when a document is loaded, its data is not initialized. Init method of CATInit has to be called after load.
See also:
CATInit
Parameters:
iStoragePrintableName
storage name of the file to load.
iReadOnly
FALSE: default value, the document will be read/write.
TRUE if the document has to lock for writing.
o Load_B
public virtual void Load_B(SEQUENCE(octet) storageName,
CATBoolean readOnly)=0
This method is not used.
o Save
public virtual void Save()=0
Saves document's data in the same file.
o SaveAs
public virtual void SaveAs(char* iStoragePrintableName,
CATBoolean iBecameCurrent)=0
Saves document's data in another file.
Parameters:
iStoragePrintableName
given storage name to specify the file where to save.
iBecameCurrent
not used.
o SaveAs_B
public virtual void SaveAs_B(SEQUENCE(octet) storageName,
CATBoolean becameCurrent)=0
This method is not used.

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

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