Public Member Functions
ErrorCode	ExportTaggedContentItem (const UIDRef &contentUIDRef, const IDFile &whereTo)

ErrorCode	ExportInCopyInterchangeToFile (const UIDList &uidList, const IDFile &idFile, INXOptions options)

ErrorCode	ExportPageitemsToFile (const UIDList &uidList, const IDFile &idFile)

ErrorCode	ImportToSpreadElement (const UIDRef &documentUIDRef, const IDFile &snippetFile, int32 whichSpread=0)

ErrorCode	ImportToElement (const UIDRef &domElementUIDRef, const IDFile &snippetFile)

ErrorCode	ImportXMLElements (const UIDRef &docUIDRef, const IDFile &whereFrom, const XMLReference &whereTo)

ErrorCode	ImportXMLElementsToRoot (const UIDRef &docUIDRef, const IDFile &whereFrom)

Detailed Description

Code that demonstrates snippet import and export using the ISnippetExport interface.

Member Function Documentation

ErrorCode SnpImportExportSnippet::ExportInCopyInterchangeToFile	(	const UIDList &	uidList,
		const IDFile &	idFile,
		INXOptions	options
	)

Export an InCopy Story to a file.

Parameters

uidList	list of objects, IDOMElement can be instantiated from each
idFile	where to export to
options	INXOptions (traditional or expanded)

ErrorCode SnpImportExportSnippet::ExportPageitemsToFile	(	const UIDList &	uidList,
		const IDFile &	idFile
	)

Export UIDList of Page Items to a file

Parameters

uidList	list of objects, IDOMElement can be instantiated from each
idFile	where to export to

ErrorCode SnpImportExportSnippet::ExportTaggedContentItem	(	const UIDRef &	contentUIDRef,
		const IDFile &	whereTo
	)

Export an XML-tagged content item (in the layout) to specified path as a snippet

Parameters

contentUIDRef
whereTo

Returns: ErrorCode kSuccess on success, other ErrorCode otherwise; ErrorCode kSuccess on success, other ErrorCode otherwise

ErrorCode SnpImportExportSnippet::ImportToElement	(	const UIDRef &	domElementUIDRef,
		const IDFile &	snippetFile
	)

Import as child of given scripting DOM element, IDOMElement

Parameters

domElementUIDRef	specifies document of interest
snippetFile

ErrorCode SnpImportExportSnippet::ImportToSpreadElement	(	const UIDRef &	documentUIDRef,
		const IDFile &	snippetFile,
		int32	whichSpread = `0`
	)

Import a snippet as a child of a specified spread

Parameters

documentUIDRef	specifies document of interest
snippetFile
whichSpread	spread index, zero based, within spreadlist (ISpreadList)

ErrorCode SnpImportExportSnippet::ImportXMLElements	(	const UIDRef &	docUIDRef,
		const IDFile &	whereFrom,
		const XMLReference &	whereTo
	)

Import XML elements in snippet into logical structure

Parameters

docUIDRef	specifies document of interest
whereFrom	snippet file
whereTo	location in logical structure from which IIDXMLElement can be instantiated

ErrorCode SnpImportExportSnippet::ImportXMLElementsToRoot	(	const UIDRef &	docUIDRef,
		const IDFile &	whereFrom
	)

Import XML elements in snippet into root of logical structure

Parameters

docUIDRef	specifies document of interest
whereFrom	snippet file