📄 classpconfig.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PConfig class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PConfig Class Reference</h1><code>#include <<a class="el" href="config_8h-source.html">config.h</a>></code><p><p>Inheritance diagram for PConfig:<p><center><img src="classPConfig.png" usemap="#PConfig_map" border="0" alt=""></center><map name="PConfig_map"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,98,24"><area href="classPSecureConfig.html" alt="PSecureConfig" shape="rect" coords="0,112,98,136"></map><a href="classPConfig-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Construction</h2></td></tr><tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classPConfig.html#z61_0">Source</a> { <a class="el" href="classPConfig.html#z61_0s0">Environment</a>, <a class="el" href="classPConfig.html#z61_0s1">System</a>, <a class="el" href="classPConfig.html#z61_0s2">Application</a>, <a class="el" href="classPConfig.html#z61_0s3">NumSources</a> }</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_1">PConfig</a> (<a class="el" href="classPConfig.html#z61_0">Source</a> src=Application)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_2">PConfig</a> (<a class="el" href="classPConfig.html#z61_0">Source</a> src, const <a class="el" href="classPString.html">PString</a> &appname)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_3">PConfig</a> (<a class="el" href="classPConfig.html#z61_0">Source</a> src, const <a class="el" href="classPString.html">PString</a> &appname, const <a class="el" href="classPString.html">PString</a> &manuf)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_4">PConfig</a> (const <a class="el" href="classPString.html">PString</a> &section, <a class="el" href="classPConfig.html#z61_0">Source</a> src=Application)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_5">PConfig</a> (const <a class="el" href="classPString.html">PString</a> &section, <a class="el" href="classPConfig.html#z61_0">Source</a> src, const <a class="el" href="classPString.html">PString</a> &appname)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_6">PConfig</a> (const <a class="el" href="classPString.html">PString</a> &section, <a class="el" href="classPConfig.html#z61_0">Source</a> src, const <a class="el" href="classPString.html">PString</a> &appname, const <a class="el" href="classPString.html">PString</a> &manuf)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#z61_7">PConfig</a> (const <a class="el" href="classPFilePath.html">PFilePath</a> &filename, const <a class="el" href="classPString.html">PString</a> &section)</td></tr><tr><td colspan=2><br><h2>Public Types</h2></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#a0">PConfig</a> (int, const <a class="el" href="classPString.html">PString</a> &name)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPConfig.html#a1">~PConfig</a> ()</td></tr><tr><td colspan="2"><div class="groupHeader">Section functions</div></td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z63_0">SetDefaultSection</a> (const <a class="el" href="classPString.html">PString</a> &section)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_1">GetDefaultSection</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPStringList.html">PStringList</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_2">GetSections</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPStringList.html">PStringList</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_3">GetKeys</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPStringList.html">PStringList</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_4">GetKeys</a> (const <a class="el" href="classPString.html">PString</a> &section) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPStringToString.html">PStringToString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_5">GetAllKeyValues</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPStringToString.html">PStringToString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z63_6">GetAllKeyValues</a> (const <a class="el" href="classPString.html">PString</a> &section) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z63_7">DeleteSection</a> ()</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z63_8">DeleteSection</a> (const <a class="el" href="classPString.html">PString</a> &section)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z63_9">DeleteKey</a> (const <a class="el" href="classPString.html">PString</a> &key)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z63_10">DeleteKey</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPConfig.html#z63_11">HasKey</a> (const <a class="el" href="classPString.html">PString</a> &key) const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPConfig.html#z63_12">HasKey</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key) const</td></tr><tr><td colspan="2"><div class="groupHeader">Get/Set variables</div></td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_0">GetString</a> (const <a class="el" href="classPString.html">PString</a> &key) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_1">GetString</a> (const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPString.html">PString</a> &dflt) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_2">GetString</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPString.html">PString</a> &dflt) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_3">SetString</a> (const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPString.html">PString</a> &value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_4">SetString</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPString.html">PString</a> &value)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPConfig.html#z65_5">GetBoolean</a> (const <a class="el" href="classPString.html">PString</a> &key, BOOL dflt=FALSE) const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPConfig.html#z65_6">GetBoolean</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, BOOL dflt=FALSE) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_7">SetBoolean</a> (const <a class="el" href="classPString.html">PString</a> &key, BOOL value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_8">SetBoolean</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, BOOL value)</td></tr><tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="classPConfig.html#z65_9">GetInteger</a> (const <a class="el" href="classPString.html">PString</a> &key, long dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="classPConfig.html#z65_10">GetInteger</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, long dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_11">SetInteger</a> (const <a class="el" href="classPString.html">PString</a> &key, long value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_12">SetInteger</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, long value)</td></tr><tr><td nowrap align=right valign=top>virtual PInt64 </td><td valign=bottom><a class="el" href="classPConfig.html#z65_13">GetInt64</a> (const <a class="el" href="classPString.html">PString</a> &key, PInt64 dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual PInt64 </td><td valign=bottom><a class="el" href="classPConfig.html#z65_14">GetInt64</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, PInt64 dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_15">SetInt64</a> (const <a class="el" href="classPString.html">PString</a> &key, PInt64 value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_16">SetInt64</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, PInt64 value)</td></tr><tr><td nowrap align=right valign=top>virtual double </td><td valign=bottom><a class="el" href="classPConfig.html#z65_17">GetReal</a> (const <a class="el" href="classPString.html">PString</a> &key, double dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual double </td><td valign=bottom><a class="el" href="classPConfig.html#z65_18">GetReal</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, double dflt=0) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_19">SetReal</a> (const <a class="el" href="classPString.html">PString</a> &key, double value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_20">SetReal</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, double value)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPTime.html">PTime</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_21">GetTime</a> (const <a class="el" href="classPString.html">PString</a> &key) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPTime.html">PTime</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_22">GetTime</a> (const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPTime.html">PTime</a> &dflt) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPTime.html">PTime</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_23">GetTime</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPTime.html">PTime</a> </td><td valign=bottom><a class="el" href="classPConfig.html#z65_24">GetTime</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPTime.html">PTime</a> &dflt) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_25">SetTime</a> (const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPTime.html">PTime</a> &value)</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPConfig.html#z65_26">SetTime</a> (const <a class="el" href="classPString.html">PString</a> &section, const <a class="el" href="classPString.html">PString</a> &key, const <a class="el" href="classPTime.html">PTime</a> &value)</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPConfig.html#n0">defaultSection</a></td></tr><tr><td> </td><td><font size=-1><em>The current section for variable values.</em> <a href="#n0"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>PXConfig * </td><td valign=bottom><a class="el" href="classPConfig.html#n1">config</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>A class representing a configuration for the application. There are four sources of configuration information. The system environment, a system wide configuration file, an application specific configuration file or an explicit configuration file.<p>Configuration information follows a three level hierarchy: {\it file}, {\it section} and {\it variable}. Thus, a configuration file consists of a number of sections each with a number of variables selected by a {\it key}. Each variable has an associated value.<p>Note that the evironment source for configuration information does not have sections. The section is ignored and the same set of keys are available.<p>The configuration file is a standard text file for the platform with its internals appearing in the form: \begin{verbatim} [Section String] Key Name=Value String \end{verbatim} <p><hr><h2>Member Enumeration Documentation</h2><a name="z61_0" doxytag="PConfig::Source"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> enum PConfig::Source </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Description of the standard source for configuration information. <dl compact><dt><b>Enumeration values: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em><a name="z61_0s0" doxytag="Environment"></a><em>Environment</em></em> </td><td>The platform specific environment. For Unix, MSDOS, NT etc this is {\bf the} environment current when the program was run. For the MacOS this is a subset of the Gestalt and SysEnviron information. </td></tr><tr><td valign=top><em><a name="z61_0s1" doxytag="System"></a><em>System</em></em> </td><td>The platform specific system wide configuration file. For MS-Windows this is the WIN.INI file. For Unix, plain MS-DOS, etc this is a configuration file similar to that for applications except there is only a single file that applies to all PWLib applications. </td></tr><tr><td valign=top><em><a name="z61_0s2" doxytag="Application"></a><em>Application</em></em> </td><td>The application specific configuration file. This is the most common source of configuration for an application. The location of this file is platform dependent, but its contents are always the same. For MS-Windows the file should be either in the same directory as the executable or in the Windows directory. For the MacOS this would be either in the System Folder or the Preferences folder within it. For Unix this would be the users home directory. </td></tr><tr><td valign=top><em><a name="z61_0s3" doxytag="NumSources"></a><em>NumSources</em></em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Constructor & Destructor Documentation</h2><a name="z61_1" doxytag="PConfig::PConfig"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PConfig::PConfig </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPConfig.html#z61_0">Source</a> </td> <td class="mdname1" valign="top" nowrap> <em>src</em> = Application </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new configuration object. Once a source is selected for the configuration it cannot be changed. Only at the next level of the hierarchy (sections) are selection able to be made dynamically with an active PConfig object. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>src</em> </td><td>Standard source for the configuration. </td></tr></table></dl> </td> </tr></table><a name="z61_2" doxytag="PConfig::PConfig"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PConfig::PConfig </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPConfig.html#z61_0">Source</a> </td> <td class="mdname" nowrap> <em>src</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>appname</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new configuration object. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>appname</em> </td><td>Standard source for the configuration. Name of application </td></tr></table></dl> </td> </tr></table><a name="z61_3" doxytag="PConfig::PConfig"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PConfig::PConfig </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPConfig.html#z61_0">Source</a> </td> <td class="mdname" nowrap> <em>src</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>appname</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>manuf</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new configuration object. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>appname</em> </td><td>Standard source for the configuration. </td></tr><tr><td valign=top><em>manuf</em> </td><td>Name of application Manufacturer </td></tr></table></dl> </td> </tr></table><a name="z61_4" doxytag="PConfig::PConfig"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PConfig::PConfig </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>section</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPConfig.html#z61_0">Source</a> </td> <td class="mdname" nowrap> <em>src</em> = Application</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new configuration object. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>src</em> </td><td>Default section to search for variables. Standard source for the configuration. </td></tr></table></dl> </td> </tr></table><a name="z61_5" doxytag="PConfig::PConfig"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -