diff --git a/tconfpy-spec.txt b/tconfpy-spec.txt index eefd690..a24affd 100644 --- a/tconfpy-spec.txt +++ b/tconfpy-spec.txt @@ -1,4 +1,4 @@ -$Id: tconfpy-spec.txt,v 1.101 2004/03/09 22:50:23 tundra Exp $ +$Id: tconfpy-spec.txt,v 1.102 2004/03/09 23:50:16 tundra Exp $ tconfpy SPECIFICATION ===================== @@ -9,14 +9,14 @@ tconfpy.ParseConfig(FileName, Options, IgnoreCase=False, Debug=False) - ---> [SymTable, ErrMsgs, InfoMsgs, DebugMsgs, ParseOK] + ---> [SymTable, ErrorrMsgs, WarningMsgs, DebugMsgs, ParseOK] where, FileName ---> String -Options ---> {"BoolOpts" : [bopt, bopt, ...], +Options ---> {"BoolOpts" : [bopt, bopt, ...], (Optional, Default={}) "NumOpts" : [nopt, nopt, ...], "StrOpts" : [sopt, sopt, ...] } @@ -53,16 +53,25 @@ associated with a particular sopt. -IgnoreCase ---> Case is ignored throughout config file. +IgnoreCase ---> Case is ignored during parse of config file. (Optional. Default: False) -SymTable ---> {Symbol Name : Symbol Value} +Debug ---> Turn on debug output. (Optional. Default: False) -ErrList ---> [ParseErr, ParseErr, ...] - ParseErr = [File Name, Line Number, Error String] -FatalError ---> If True, means parsing failed pathologically, and - pgm should not continue +RETURN VALUES +------------- + + +SymTable ---> {Symbol Name : [Symbol Value, option, option, ...]} + +ErrorMsgs ---> List of Error Messages + +DebugMsgs ---> List of Debug Messages (empty if Debug=False) + +WarningMsgs ---> List of Warning Messages + +ParseOK ---> If True, parsing was successful. ------------------------------------------------------------------------------