CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
CFxProfileStorage Class Referenceabstract

#include <FxProfile.h>

Public Member Functions

virtual ~CFxProfileStorage ()
 
virtual int CreateNode (const CFxString &pszNodePath, QDomNode *&pNode)=0
 
virtual int GetNode (const CFxString &pszNodePath, QDomNode *&pNode)=0
 
virtual int ReplaceNode (const CFxString &pszNodePath, QDomNode *pNode)=0
 
virtual int DeleteNode (const CFxString &pszNodePath)=0
 
virtual int GetStorageFile (CFxString &fileName)=0
 
virtual int Save (void)=0
 

Detailed Description

Description: Represents the profile storage data. Library: DDKERNEL

Definition at line 374 of file FxProfile.h.

Constructor & Destructor Documentation

◆ ~CFxProfileStorage()

virtual CFxProfileStorage::~CFxProfileStorage ( )
inlinevirtual

Definition at line 377 of file FxProfile.h.

Member Function Documentation

◆ CreateNode()

virtual int CFxProfileStorage::CreateNode ( const CFxString & pszNodePath,
QDomNode *& pNode )
pure virtual

Description: Creates a node in the XML file at the specified path. If the node already exists, it gets the existing node. Arguments:

Parameters
pszNodePathInput XML node path specifying the node to create
pNodeOutput reference to receive the IUnknown interface of created IXMLDOMNode interface

◆ DeleteNode()

virtual int CFxProfileStorage::DeleteNode ( const CFxString & pszNodePath)
pure virtual

Description: Deletes the node in the XML file at the specified path. Arguments:

Parameters
pszNodePathInput XML node path specifying the node to delete; for example, ToolPalette\ToolPaletteSets\ToolPaletteSet

◆ GetNode()

virtual int CFxProfileStorage::GetNode ( const CFxString & pszNodePath,
QDomNode *& pNode )
pure virtual

Description: Gets the node in the XML file at the specified path. Arguments:

Parameters
pszNodePathInput XML node path specifying the node to get; for example, ToolPalette\ToolPaletteSets\ToolPaletteSet
pNodeOutput reference to receive the IUnknown interface of IXMLDOMNode pointer for the specified node path; set to NULL if the node is not found

◆ GetStorageFile()

virtual int CFxProfileStorage::GetStorageFile ( CFxString & fileName)
pure virtual

Description: Gets the physical storage file in which the profile is stored. Arguments:

Parameters
pszFileInput pointer to character buffer to receive the profile storage file with path; the buffer length should be at least MAX_PATH length

◆ ReplaceNode()

virtual int CFxProfileStorage::ReplaceNode ( const CFxString & pszNodePath,
QDomNode * pNode )
pure virtual

Description: Replaces the node in the XML file at the specified path with the specified node. The replaced node is released. Arguments:

Parameters
pszNodePathInput XML node path specifying the node to replace; for example, ToolPalette\ToolPaletteSets\ToolPaletteSet
pNodeInput IUnknown interface of IXMLDOMNode pointer to replace the existing node at the specified node path

◆ Save()

virtual int CFxProfileStorage::Save ( void )
pure virtual

Description: Saves the profile storage XML file. The profile storage file is saved automatically when required. For example, it will be saved when the profile is switched or renamed or when the session ends. Use this function to force a save of the file immediately if necessary.


The documentation for this class was generated from the following file: