X2 Standard  Version 1.24
Public Member Functions | List of all members
BasicIniUtilInterface Class Referenceabstract

The BasicIniUtilInterface is used to make properties persistent. More...

#include <basiciniutilinterface.h>

Public Member Functions

virtual int readInt (const char *szParentKey, const char *szChildKey, const int &nDefault)=0
 
virtual int writeInt (const char *szParentKey, const char *szChildKey, const int &nValue)=0
 
virtual double readDouble (const char *szParentKey, const char *szChildKey, const double &dDefault)=0
 
virtual int writeDouble (const char *szParentKey, const char *szChildKey, const double &dValue)=0
 
virtual void readString (const char *szParentKey, const char *szChildKey, const char *szDefault, char *szResult, int nMaxSizeOfResultIn)=0
 
virtual int writeString (const char *szParentKey, const char *szChildKey, const char *szValue)=0
 

Detailed Description

The BasicIniUtilInterface is used to make properties persistent.

The BasicIniUtilInterface is a cross-platform utility making it easy for X2 implementors to make properties persistent. X2 implementors are purposefully hidden from any path, filename, instance specifics which is handled by TheSkyX's implementation of this interface.

The Reads never fail because a default value is passed. The Write might fail and an error code is returned, but this rarely happens. Tested and works on Windows, Mac, Ubuntu Linux.

Member Function Documentation

◆ readDouble()

virtual double BasicIniUtilInterface::readDouble ( const char *  szParentKey,
const char *  szChildKey,
const double &  dDefault 
)
pure virtual

Read a double from a persistent state.

◆ readInt()

virtual int BasicIniUtilInterface::readInt ( const char *  szParentKey,
const char *  szChildKey,
const int &  nDefault 
)
pure virtual

Read an integer from a persistent state.

◆ readString()

virtual void BasicIniUtilInterface::readString ( const char *  szParentKey,
const char *  szChildKey,
const char *  szDefault,
char *  szResult,
int  nMaxSizeOfResultIn 
)
pure virtual

Read a string from a persistent state.

◆ writeDouble()

virtual int BasicIniUtilInterface::writeDouble ( const char *  szParentKey,
const char *  szChildKey,
const double &  dValue 
)
pure virtual

Write a double to a persistent state.

◆ writeInt()

virtual int BasicIniUtilInterface::writeInt ( const char *  szParentKey,
const char *  szChildKey,
const int &  nValue 
)
pure virtual

Write an integer to a persistent state.

◆ writeString()

virtual int BasicIniUtilInterface::writeString ( const char *  szParentKey,
const char *  szChildKey,
const char *  szValue 
)
pure virtual

Write a string to a persistent state.


The documentation for this class was generated from the following file:
X2 Examples
(C) Software Bisque, Inc. All rights reserved.