aflibenvfile.3

来自「一个共享源码的音频库5(doc 文档)」· 3 代码 · 共 72 行

.TH "aflibEnvFile" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibEnvFile \- Manages settings for each individual of a program. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibEnvFile.h>\fP
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibEnvFile\fP (char *env_file, char *env_dir=NULL)"
.br
.RI "\fIConstructor with parameters.\fP"
.ti -1c
.RI "\fBaflibEnvFile\fP ()"
.br
.ti -1c
.RI "\fB~aflibEnvFile\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "bool \fBreadValueFromFile\fP (string &key_str, string &results)"
.br
.RI "\fIRead a value from a file.\fP"
.ti -1c
.RI "void \fBwriteValueToFile\fP (string &key_str, string &value)"
.br
.RI "\fIWrite a value to a file.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Manages settings for each individual of a program.
.PP
This class will create a .<name> directory in the users home directory or a directory for the users choice. It will then manage a set of key values that the programmer can search for. This allows programmers to save a users settings and then retrieve then at a latter time. It currently supports upto 1024 different settings. Two constructors are provided. They will dertermine what directory to look for the settings file and what the name of the file is. If the directory is not specified then a default directory of .<DEFAULT_DIR> will be created in the users home directory. A file will be created in this directory. The name will be the one specified by the caller. If none is specified then DEFAULT_FILE will be created. To retrieve and store strings into the file readValueFromFile and writeValueToFile should be called. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibEnvFile::aflibEnvFile (char * env_file, char * env_dir = NULL)"
.PP
Constructor with parameters.
.PP
This will create a environment directory name to use with env_dir. If this is NULL then a default directory in the users home directory will be used. If env_file is set then this file name will be used in the env_dir. Otherwise a default file name will be used in the env_dir. 
.SS "aflibEnvFile::aflibEnvFile ()"
.PP
Constructor with no parameters.
.PP
This constructor will use defaults for the directory and env files. 
.SS "aflibEnvFile::~aflibEnvFile ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "bool aflibEnvFile::readValueFromFile (string & key_str, string & results)"
.PP
Read a value from a file.
.PP
This function will read a string from the env file that corresponds to the key key_str passed in. 
.SS "void aflibEnvFile::writeValueToFile (string & key_str, string & value)"
.PP
Write a value to a file.
.PP
This function will write a value for the key key_str. If the key_str already exists then it will be overwritten. 

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.