Persist custom data in document / Is ASB-CSB, Command the only way?

Question

I have a need to persist custom data set (PMString for now) in a document, say for example source URL. Basic Persist sample suggests using implementing suites and commands. I was wondering if there is a quick way of doing such a simple task. XMP may be?
Thanks

Answer 1

Hi Carl,<br /><br />What you need is the header file : 'IWFPParamaSerial.h'<br /><br />>#include "VCPlugInHeaders.h"<br /><br />>#include "IPMUnknown.h"<br />#include "WFPID.h"<br /><br />>class IWFPParamSerial : public IPMUnknown<br />{<br />public :      <br />     enum { kDefaultIID = IID_IWFPPARAMSERIAL };<br />     virtual void SetParams(const PMString &pmstrParams)=0;<br />     virtual void GetParams(PMString &pmstrParams) = 0;<br />};<br /><br />Then, the implementation :'IWFPParamaSerial.cpp'<br /><br />>#include "VCPlugInHeaders.h"<br />// Interface includes<br />#include "IWFPParamSerial.h"<br />#include "WFPID.h"<br />// General includes:<br />#include "CPMUnknown.h"<br />#include "K2Vector.h"<br />#include "IPMStream.h"<br /><br />>class WFPParamSerial : public CPMUnknown<IWFPParamSerial><br />{<br />public:<br />     /**     Constructor. */<br />     WFPParamSerial(IPMUnknown* boss);<br />     /**     Destructor.     */<br />     ~WFPParamSerial(){};<br />     virtual void SetParams(const PMString &pmstrParams);<br />     virtual void GetParams(PMString &pmstrParams);          <br />     void ReadWrite(IPMStream* stream, ImplementationID implementation);<br />private :          <br />     PMString m_pstrParams;<br />};<br /><br />>CREATE_PERSIST_PMINTERFACE(WFPParamSerial, kWFPParamSerialImpl)<br /><br />>WFPParamSerial::WFPParamSerial(IPMUnknown* boss) : CPMUnknown<IWFPParamSerial>(boss)<br />{<br />}<br /><br />>void WFPParamSerial::SetParams(const PMString &pmstrParams)<br />{<br />     if (pmstrParams != m_pstrParams)<br />     {<br />          PreDirty();<br />          m_pstrParams = pmstrParams;<br />     }<br />}<br /><br />>void WFPParamSerial::GetParams(PMString &pmstrParams)<br />{<br />     pmstrParams = m_pstrParams;<br />}<br /><br />>void WFPParamSerial::ReadWrite(IPMStream* stream, ImplementationID implementation)<br />{<br />     m_pstrParams.ReadWrite(stream);<br />}<br /><br />Of course, in the 'WFPID.h', declarations for interface & implementation IDs :<br /><br />>DECLARE_PMID(kInterfaceIDSpace, IID_IWFPPARAMSERIAL,     kWFPPrefix + 1)<br />DECLARE_PMID(kImplementationIDSpace, kWFPParamSerialImpl,     kWFPPrefix + 6)<br /><br />In 'WFPFactory.h' :<br />>REGISTER_PMINTERFACE(kWFPParamSerialImpl, kWFPParamSerialImpl)<br /><br />And in 'WFP.fr', add it to relevant boss (<br /><br />>resource ClassDescriptionTable(kSDKDefClassDescriptionTableResourceID)<br />{{{<br />...<br />AddIn<br />     {<br />          kDocWorkspaceBoss,<br />          kInvalidClass,<br />          {<br />               IID_IWFPPARAMSERIAL, kWFPParamSerialImpl,<br />           }<br />     },<br />...<br />}}};<br /><br />Then when you have a IWorkSpace interface, you can set or get it :<br /><br />>InterfacePtr<IWorkspace> iDocWorkSpace(iDoc->GetDocWorkSpace(), UseDefaultIID());<br />if (!iDocWorkSpace) return;<br />InterfacePtr<IWFPParamSerial> iParamSerial(iDocWorkSpace, UseDefaultIID());<br />if (!iParamSerial) return;<br />PMString strParams;<br />iParamSerial->GetParams(strParams);<br /><br />HTH (and I forgot nothing :-)<br /><br />J.