Inheritance diagram for IInCopyWorkflow:

Public Types
enum	{ kDefaultIID = IID_IINCOPYWORKFLOW }

Public Member Functions
virtual ErrorCode	ImportStory (const UIDRef &storyRef, IPMStream iInStream, IInCopyImportOptions options, const UIDRef &storyBeingReplaced=UIDRef::gNull)=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

IInCopyWorkflow is the main developer access to import a story from an InCopy INCD file/stream.

Exporting to InCopy INCD is no longer supported.

An InCopy INCD file is an XML based format that uses namespaced element names and attributes. See InCopyImportExportDefs.h and InCopyCharAttrElemNames.h

Member Function Documentation

virtual ErrorCode IInCopyWorkflow::ImportStory	(	const UIDRef &	storyRef,
		IPMStream *	iInStream,
		IInCopyImportOptions *	options,
		const UIDRef &	storyBeingReplaced = `UIDRef::gNull`
	)

pure virtual

Import the story from the given stream.

Parameters

storyRef	The target story to import into. If this story is brand new story intended to replace another story, the other story can be specified in the storyBeingReplaced parameter (see below).
iInStream	The input stream to parse the XML from.
options	Options the caller can provide to control the import. The classID kInCopyImportOptionsBoss can be used by the caller as the container class for the interface. In other words, the caller does not need to have their own implementation of this interface.
storyBeingReplaced	The story the target story is replacing. Can be set if the method wants to preserve any data such as inline graphics from the original story. Import providers should set this parameter in their ImportThis methods, since the place behavior sometimes causes stories to be replaced entirely. In that case, ImportStory can copy data from storyBeingReplaced into the new target story before storyBeingReplaced is deleted.