CFx SDK Documentation  2020SP3
Public Member Functions | Static Public Member Functions | List of all members
OdOleStorage Class Referenceabstract

#include <OleStorage.h>

Inheritance diagram for OdOleStorage:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdOleStorage)
 
virtual void init (OdByteData *pByteData, int accessMode=Oda::kFileRead)=0
 
virtual OdByteDataPtr rawData () const =0
 
virtual OdStreamBufPtr openStream (const OdString &filename, bool createIfNotFound=false, int accessMode=Oda::kFileRead)=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdOleStoragePtr createServiceObject (OdByteData *pInitData)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the base class for custom classes that implement OLE storage.

Corresponding C++ library: TD_Db <group Other_Classes>

Definition at line 111 of file OleStorage.h.

Member Function Documentation

◆ createServiceObject()

static OdOleStoragePtr OdOleStorage::createServiceObject ( OdByteData pInitData)
static

Creates a service object for this OleStorage object.

Parameters
pInitData[in] Pointer to the initial data.

◆ init()

virtual void OdOleStorage::init ( OdByteData pByteData,
int  accessMode = Oda::kFileRead 
)
pure virtual

Initializes this OleStorage object.

Parameters
pByteData[in] Pointer to the OdByteData for this OleStorage object.
accessMode[in] Mode in which to open this OleStorage object.
Remarks
accessMode must be a combination of one or more of the following:

Value Description Oda::kFileRead 0x80000000 Read access. Oda::kFileWrite 0x40000000 Write access.

◆ ODRX_DECLARE_MEMBERS()

OdOleStorage::ODRX_DECLARE_MEMBERS ( OdOleStorage  )

◆ openStream()

virtual OdStreamBufPtr OdOleStorage::openStream ( const OdString filename,
bool  createIfNotFound = false,
int  accessMode = Oda::kFileRead 
)
pure virtual

Opens an OdStreamBuf for this OleStorage object. For internal use only.

Parameters
filename[in] Filename.
accessMode[in] Mode in which to open this OleStorage object.
createIfNotFound[in] Controls the creation of the file if it does not exist.
Returns
Returns a SmartPointer for the newly created OdStreamBuf object.
Remarks
accessMode must be a combination of one or more of the following:

Value Description Oda::kFileRead 0x80000000 Read access. Oda::kFileWrite 0x40000000 Write access.

Remarks
createIfNotFound is for Teigha internal use only, and should always be false for Teigha applications.

◆ rawData()

virtual OdByteDataPtr OdOleStorage::rawData ( ) const
pure virtual

Returns the raw OdByteData for this OleStorage object.


The documentation for this class was generated from the following file: