Fovia's C++ Client/Server API
Public Member Functions | List of all members
IPresetUtils Struct Referenceabstract
Inheritance diagram for IPresetUtils:
IRoot

Public Member Functions

virtual signed int AskInterface (const BGUID *piid, IRoot **ppr)=0
 
virtual signed int DecRef ()=0
 
virtual signed int IncRef ()=0
 
virtual signed int ReadParamsFromXml (char *pzPathName, RENDER_PARAMS *rp)=0
 
virtual signed int WriteParamsToXml (char *pzPathName, RENDER_PARAMS rp)=0
 
- Public Member Functions inherited from IRoot
template<class T >
signed int AskInterface (T **pp)
 

Detailed Description

Interface that allows reading and writing of XML preset files on the client.

Member Function Documentation

virtual signed int IPresetUtils::AskInterface ( const BGUID piid,
IRoot **  ppr 
)
pure virtual

Queries this object to see if the interface piid is supported and returns the result in ppr.

Parameters
piidThe BGUID of the requested interface.
pprThe address of an IRoot pointer which will receive the new interface.
Returns
S_OK if the interface is supported. E_FAIL if it is not.

Implements IRoot.

virtual signed int IPresetUtils::DecRef ( )
pure virtual

Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.

Implements IRoot.

virtual signed int IPresetUtils::IncRef ( )
pure virtual

Increases the reference count on this object by 1. You do not need to call this after an object is first created. It is 1 by default.

Implements IRoot.

virtual signed int IPresetUtils::ReadParamsFromXml ( char *  pzPathName,
RENDER_PARAMS rp 
)
pure virtual

Reads a file saved by WriteParamsToXml. WARNING: This function is not thread safe!

Parameters
pzPathNameString containing the path to the file.
rpRENDER_PARAMS to receive the parameters stored in the file.
virtual signed int IPresetUtils::WriteParamsToXml ( char *  pzPathName,
RENDER_PARAMS  rp 
)
pure virtual

Writes the RENDER_PARAMS to disk in a human-readable XML format. WARNING: This function is not thread safe!

Parameters
pzPathNameString containing the path where you wish to save the file.
rpRENDER_PARAMS to save