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

#include <ICopyStreamData.h>

Inheritance diagram for ICopyStreamData:
IPMUnknown

Public Member Functions

virtual void Set (IDataBase *srcDB, IDataBase *destDB, IXferBytes *xferBytes)=0
 
virtual IDataBaseGetSourceDataBase () const =0
 
virtual IDataBaseGetDestinationDataBase () const =0
 
virtual IXferBytesGetXferBytes () 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 a copy stream. Copy streams are sometimes used

to copy the data out of an object, into a stream, or to instantiate an object

that was copied out. This is very low level functionality; look in ScrapUtils

to see if that can meet your needs before using copy streams. Even if you do

need a copy stream, normally you can get the stream from StreamUtil instead of

setting it up yourself. This interface is only useful if you get passed a stream

and need to know what its target is.

See Also
ScrapUtil
StreamUtil

Member Function Documentation

virtual IDataBase* ICopyStreamData::GetDestinationDataBase () const
pure virtual

Get the destination database for the copy

Returns
destination database
virtual IDataBase* ICopyStreamData::GetSourceDataBase () const
pure virtual

Get the source database for the copy

Returns
source database
virtual IXferBytes* ICopyStreamData::GetXferBytes () const
pure virtual

Get the stream bytes for the copy

Returns
stream bytes
virtual void ICopyStreamData::Set (IDataBasesrcDB,
IDataBasedestDB,
IXferBytesxferBytes 
)
pure virtual

Set the information required for the copy.

Parameters
srcDBsource database
destDBdestination database
xferBytesunderlying stream data