InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXMLAcquirerFilter Class Referenceabstract
Inheritance diagram for IXMLAcquirerFilter:
IPMUnknownCPMUnknown< IXMLAcquirerFilter >XCatHndAcquirerFilter

Public Types

enum  { kDefaultIID = IID_IXMLACQUIRERFILTER }
 

Public Member Functions

virtual int32 GetFileTypeCount () const =0
 
virtual void GetNthFileType (int32 n, PMString *family, PMString *extension, SysOSType *type) const =0
 
virtual StreamResolverPair CreateStreamAndResolver (IImportXMLData *importData, ErrorCode *errCode) const =0
 
virtual ISAXEntityResolverCreateResolver (IImportXMLData *importData, ErrorCode *errCode) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ISAXEntityResolver* IXMLAcquirerFilter::CreateResolver (IImportXMLDataimportData,
ErrorCode * errCode 
) const
pure virtual

Create an entity resolver to use when parsing the stream.

Returns
the entity resolver. Return nil if this provider doesn't support
Parameters
importDataIN The data of import information.
errCodeOUT An error code. Must not be nil. this file or if it doesn't want to create a special entity resolver.

Implemented in XCatHndAcquirerFilter.

virtual StreamResolverPair IXMLAcquirerFilter::CreateStreamAndResolver (IImportXMLDataimportData,
ErrorCode * errCode 
) const
pure virtual

Create a read stream based on the import data. Also create an entity resolver to use when parsing the stream.

Parameters
importDataIN The data of import information.
errCodeOUT An error code. Must not be nil.
Returns
the stream and entity resolver. Return nil for both the stream and the resolver if the provider can't create a stream. Return nil for the resolver if this provider doesn't want to create its own resolver.

Implemented in XCatHndAcquirerFilter.

virtual int32 IXMLAcquirerFilter::GetFileTypeCount () const
pure virtual

Use this method to find out how many filetypes this particular filter supports

Returns
the number of filetypes supported

Implemented in XCatHndAcquirerFilter.

virtual void IXMLAcquirerFilter::GetNthFileType (int32 n,
PMStringfamily,
PMStringextension,
SysOSType * type 
) const
pure virtual

Get the information about the nth filter

Parameters
nIN which filetype client wants to know about
familyOUT The file type family (Pretty much always XML)
extensionOUT The Windows file extension
typeOUT The Mac filetype

Implemented in XCatHndAcquirerFilter.