InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IMemoryStreamData Class Referenceabstract

#include <IMemoryStreamData.h>

Inheritance diagram for IMemoryStreamData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMEMORYSTREAMDATA }
 

Public Member Functions

virtual void Set (IXferBytes *underlyingXferBytes, bool16 takeOwnership=kFalse)=0
 
virtual IXferBytesGetXferBytes () const =0
 
virtual bool16 IsOwnedXferBytes () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for controlling memory-based streams

See Also
StreamUtil

Member Function Documentation

virtual IXferBytes* IMemoryStreamData::GetXferBytes () const
pure virtual

Return a pointer to the associated XferBytes object.

Returns
A pointer to the current XferBytes object, or nil.
virtual bool16 IMemoryStreamData::IsOwnedXferBytes () const
pure virtual

Determine whether we are responsible for the lifetime of the current XferBytes object, if any.

Returns
kTrue if we are responsible, kFalse if we are not (or if there is no associated XferBytes object).
virtual void IMemoryStreamData::Set (IXferBytesunderlyingXferBytes,
bool16 takeOwnership = kFalse 
)
pure virtual

Set the stream's associated XferBytes object. If the XferBytes object was dynamically allocated, responsibility for its lifetime may be assigned to IMemoryStreamData.

Parameters
underlyingXferBytesIN A pointer to the XferBytes object.
takeOwnershipIN kTrue if IMemoryStreamData should take ownership of the XferBytes object, kFalse if not.