#include <IPreflightAggregatedResultsExport.h>

Inheritance diagram for IPreflightAggregatedResultsExport:

Classes
class	ReportFileTypeInfo

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTAGGREGATEDRESULTSEXPORT }

typedef K2Vector < ReportFileTypeInfo >	ReportFileTypeInfoVector

Public Member Functions
virtual ErrorCode	GetExportFileParameters (const PMString &sDocName, bool isBook, const PMString &sProfileName, IDFile &defaultFile, ReportFileTypeInfoVector &fileTypes) const =0

virtual ErrorCode	ExportToFile (const PMString &sDocName, bool isBook, const PMString &sProfileName, const IDFile &exportFile, bool openAfterCreate) const =0

virtual void	PackageResults (const PMString &sDocName, const PMString &sProfileName, ScriptListData &resultEntries) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This helper interface handles export functions for aggregated results. It sits on the 

same boss as IPreflightAggregatedResults. Since these methods don't really have anything 

to do with the model, we don't want to clutter up the IPreflightAggregatedResults

interface.

See Also

IPreflightAggregatedResults

Typical usage:



    DoExport(IPreflightAggregatedResults* iResults)

    {

        InterfacePtr<IPreflightAggregatedResultsExport> iExport(iResults, UseDefaultIID());

        ReportFileTypeInfoVector types;

        iExport->GetExportFileParameters(docName, kFalse, profileName, defFile, &types);

Set up your save-as dialog with 'types' or however you intend to use it IDFile destFile = AskUserForDestination(types);

iExport->ExportToFile(docName, kFalse, profileName, destFile, kTrue); }

See also the preflight export generating script found in the scripts/preflight folder.

Member Function Documentation

virtual ErrorCode IPreflightAggregatedResultsExport::ExportToFile	(	const PMString &	sDocName,
		bool	isBook,
		const PMString &	sProfileName,
		const IDFile &	exportFile,
		bool	openAfterCreate
	)		const

pure virtual

Exports the report to the specified file. Note that the supported output types may vary depending on the script providing that capability; to be sure you can export to the file,

See Also: GetExportFileParameters.

Parameters

sDocName	IN The name of the document that was preflighted.
isBook	IN True if the 'document' is a book; False if it's an INDD.
sProfileName	IN The name of the profile that was used.
exportFile	IN The file to export to.
openAfterCreate	IN True to open (display) the file after creation.

Returns: Error code, or kSuccess if successful.

virtual ErrorCode IPreflightAggregatedResultsExport::GetExportFileParameters	(	const PMString &	sDocName,
		bool	isBook,
		const PMString &	sProfileName,
		IDFile &	defaultFile,
		ReportFileTypeInfoVector &	fileTypes
	)		const

pure virtual

Gets the parameters needed to produce a save-as dialog for the report.

See Also: ExportToFile.

Parameters

sDocName	IN The name of the document that was preflighted.
isBook	IN True if the 'document' is a book; False if it's an INDD.
sProfileName	IN The name of the profile that was used.
defaultFile	OUT Receives the IDFile representing the default save-as file name/location.
sDesc	OUT Receives the description of the file type.
fileType	OUT Receives the file type ID (MacOS)
creatorType	OUT Receives the file creator type (MacOS)
sExtension	OUT Receives the extension to use.

Returns: Error code, or kSuccess if successful.

Classes

Public Types

Public Member Functions

Detailed Description

Member Function Documentation