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

#include <IPreflightResultRecordTable.h>

Inheritance diagram for IPreflightResultRecordTable:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTRESULTRECORDTABLE }
 

Public Member Functions

virtual int32 GetRecordCount () const =0
 
virtual const
IPreflightResultRecord
QueryNthRecord (int32 n) const =0
 
virtual void AddRecord (const IPreflightResultRecord *iRec)=0
 
virtual void AppendTable (const IPreflightResultRecordTable *iOther)=0
 
virtual void ReadData (PreflightXferStream &s)=0
 
virtual void WriteData (PreflightXferStream &s) 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

This interface manages an array/vector of IPreflightResultRecord references. It's used extensively by the preflight aggregated results utilities and preflight rules.

See Also
IPreflightResultRecord
IPreflightAggregatedResultsUtils

This interface sits on its own boss by itself, typically. You can create an empty one of these via IPreflightAggregatedResultsUtils::CreatePreflightResultRecordTable, but more typically you use IPreflightAggregatedResultsUtils::CreateTableFromNodes and various other create-table-via-filter methods in that interface.

Member Function Documentation

virtual void IPreflightResultRecordTable::AddRecord (const IPreflightResultRecordiRec)
pure virtual

Adds a record to the table. This isn't terribly common in rules because most of the time they're simply grouping existing results and those generated via IPreflightAggregatedResultsUtils::ApplyAllStandardAggregations (et al). But there's no reason you can't build a table exactly the way you like with this API.

Parameters
iRecIN The record to add. It's appended to the end of the table.
virtual void IPreflightResultRecordTable::AppendTable (const IPreflightResultRecordTableiOther)
pure virtual

Appends an entire table. Note that there's no attempt to merge, ie identify like entries; it's simply appended.

Parameters
iOtherIN The other table whose records you want to add.
virtual int32 IPreflightResultRecordTable::GetRecordCount () const
pure virtual
Returns
the number of records in the table.
virtual const IPreflightResultRecord* IPreflightResultRecordTable::QueryNthRecord (int32 n) const
pure virtual

Get a record.

Parameters
nIN The index of the record.
Returns
a refcounted interface, or nil if error.
virtual void IPreflightResultRecordTable::ReadData (PreflightXferStream & s)
pure virtual

Internal use only. Used to serialize from a blob in the database.

virtual void IPreflightResultRecordTable::WriteData (PreflightXferStream & s) const
pure virtual

Internal use only. Used to serialize to a blob in the database.