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

#include <IFileStreamData.h>

Inheritance diagram for IFileStreamData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IFILESTREAMDATA }
 

Public Member Functions

virtual void Set (const IDFile &sysFile, uint32 mode, OSType fileType=0x3f3f3f3f, OSType creator=0x3f3f3f3f)=0
 
virtual const IDFileGetSysFile () const =0
 
virtual uint32 GetMode () const =0
 
virtual OSType GetFileType () const =0
 
virtual OSType GetCreator () 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

Container interface used to hold information about a file accessed via a file stream.

See Also
IDFile

Member Function Documentation

virtual OSType IFileStreamData::GetCreator () const
pure virtual

Returns the creator of the file accessed via the stream.

Returns
Creator of the file accessed via the stream.
virtual OSType IFileStreamData::GetFileType () const
pure virtual

Returns the file type of the file accessed via the stream.

Returns
File type of the file accessed via the stream.
virtual uint32 IFileStreamData::GetMode () const
pure virtual

Returns the file mode used by the stream when opening the file.

Returns
File mode used by the stream when opening the file.
virtual const IDFile& IFileStreamData::GetSysFile () const
pure virtual

Returns the file accessed via the stream.

Returns
Reference to the file accessed via the stream.
virtual void IFileStreamData::Set (const IDFilesysFile,
uint32 mode,
OSType fileType = 0x3f3f3f3f,
OSType creator = 0x3f3f3f3f 
)
pure virtual

Sets information about the file accessed via the stream.

Parameters
sysFileIN File accessed via the stream.
modeIN File mode used by the stream when opening the given file.
fileTypeIN File type of the given file.
creatorIN Creator of the given file.