IAttrImportExport Class Reference

#include <IAttrImportExport.h>

Inheritance diagram for IAttrImportExport:

Public Types
enum	SetValueErrorCode { kNoError = 0x00, kConversionError = 0x01, kOutOfRange = 0x02, kInvalidValue = 0x03 }

Public Member Functions
virtual void	GetTagName (PMString *pTagName) const =0
virtual void	GetTagAbbr (PMString *pTagAbbr) const =0
virtual void	GetTagValue (PMString *pTagValue, IDataBase *dB=nil) const =0
virtual IAttrImportExport::SetValueErrorCode	SetTagValue (const PMString &rTagValue, IDataBase *dB=nil)=0
virtual PMIID	GetDataPMIID () const =0
virtual ClassID	GetClassID () const =0
virtual void	ReadWriteTagValue (IPMStream *s, EncodingType encoding, IDataBase *dB=nil)=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

Utility interface for the tagged text attributes import and export.

Member Enumeration Documentation

enum IAttrImportExport::SetValueErrorCode

Global error codes

Enumerator
kNoError	No error
kConversionError	Error in value conversion
kOutOfRange	Value is out of range
kInvalidValue	Invalid value

Member Function Documentation

virtual ClassID IAttrImportExport::GetClassID ( ) const

pure virtual

Get the BossID of Boss to which the attribute belongs

Parameters

none

Returns

ClassID

virtual PMIID IAttrImportExport::GetDataPMIID ( ) const

pure virtual

Get the PMIID of the Data Interface to which the attribute belongs

Parameters

none

Returns

PMIID PMIID of the Data interface

virtual void IAttrImportExport::GetTagAbbr ( PMString *  pTagAbbr ) const

pure virtual

Get the abbreviated tag name

Parameters

pTagAbbr

OUT Abbreviated tag name

virtual void IAttrImportExport::GetTagName ( PMString *  pTagName ) const

pure virtual

Get the verbose tag name

Parameters

pTagName

OUT Verbose tag name

virtual void IAttrImportExport::GetTagValue ( PMString *  pTagValue, IDataBase *  dB = nil  ) const

pure virtual

Get the tag value

Parameters

pTagValue	OUT Tag value
dB	IN Database associated with the tag

virtual void IAttrImportExport::ReadWriteTagValue ( IPMStream *  s, EncodingType  encoding, IDataBase *  dB = nil  )

pure virtual

Read/Write the Tag Value from stream based on the stream type

Parameters

s	INOUT Stream
encoding	IN Encoding type
dB	IN Database associated with the attribute

virtual IAttrImportExport::SetValueErrorCode IAttrImportExport::SetTagValue ( const PMString &  rTagValue, IDataBase *  dB = nil  )

pure virtual

Set the tag value

Parameters

rTagValue	IN Tag value
dB	IN Database associated with the tag

Returns

IAttrImportExport::SetValueErrorCode Error occurred while doing value conversion, return kNoError if succeeded