IImageTagService Class Reference

#include <IImageTagService.h>

Inheritance diagram for IImageTagService:

Public Member Functions
virtual bool8	ImportTagData (int16 tagID, const UIDRef &item, void *tagData, uint32 dataSize)=0
virtual bool8	ExportTagData (int16 tagID, const UIDRef &item, void **tagData)=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

Interface that defines a mechanism for importing and exporting image tags.

Note: This interface is for internal use only. The code that uses this interface looks for a specific implementation and so does not provide a way for third-party developers to provide their own implementations. In addition, the data provided by the one existing implementation is for internal use only and is intentionally undocumented.

Member Function Documentation

virtual bool8 IImageTagService::ExportTagData ( int16  tagID, const UIDRef &  item, void **  tagData  )

pure virtual

Exports data for the specified tag.

Note: The implementation should take the item and extract the data corresponding to the tagID. It should then pass back a pointer to newly created data. The caller owns the returned data and is responsible for cleaning it up.

Parameters

tagID	IN The selector for the tag being exported
item	IN The page item to export from
tagData	OUT Receives a pointer to the data for the tag

Returns

kTrue if the method succeeds, else kFalse

virtual bool8 IImageTagService::ImportTagData ( int16  tagID, const UIDRef &  item, void *  tagData, uint32  dataSize  )

pure virtual

Imports data for the specified tag.

Note: The implementation can assume the incoming tagData holds data corresponding to the tagID. It is free to do whatever it needs to with this data, but must not delete it.

Parameters

tagID	IN The selector for the tag being imported
item	IN The page item to import to
tagData	IN The data for the tag
dataSize	IN The size of the data

Returns

kTrue if the method succeeds, else kFalse