Qore Programming Language Reference Manual  1.0.8
QC_GetOpt.dox.h
1 
3 namespace Qore {
5 /***/
6 class GetOpt {
7 
8 public:
10 
38  constructor(hash<auto> options);
39 
40 public:
42 
44  copy();
45 
46 public:
48 
68 hash<auto> parse(reference<list<string>> pgm_args);
69 
70 public:
72 
89 hash<auto> parse(softlist<auto> pgm_args);
90 
91 public:
93 
113 hash<auto> parse2(reference<list<string>> pgm_args);
114 
115 public:
117 
137 hash<auto> parse2(softlist<auto> pgm_args);
138 
139 public:
141 
157 hash<auto> parse3(reference<list<string>> pgm_args);
158 
159 public:
161 
179 hash<auto> parse3(softlist<auto> pgm_args);
180 
181 public:
183 
229 static hash<auto> parse(hash<auto> opts, reference<list<string>> pgm_args);
230 
231 public:
233 
275 static hash<auto> parseEx(hash<auto> opts, reference<list<string>> pgm_args);
276 
277 public:
279 
321 static hash<auto> parseExit(hash<auto> opts, reference<list<string>> pgm_args);
322 };
323 }
constructor(hash< auto > options)
Creates the GetOpt object and sets the option hash with the single required argument.
hash< auto > parse(reference< list< string >> pgm_args)
Parses the parameter list according to the option hash passed to the constructor. ...
hash< auto > parse2(reference< list< string >> pgm_args)
Parses the parameter list according to the option hash passed to the constructor. ...
static hash< auto > parseEx(hash< auto > opts, reference< list< string >> pgm_args)
Parses the given options and returns a hash of the parsed options and throws and exception if there a...
hash< auto > parse3(reference< list< string >> pgm_args)
Parses the parameter list according to the option hash passed to the constructor and displays an expl...
copy()
Throws an exception; objects of this class cannot be copied.
static hash< auto > parseExit(hash< auto > opts, reference< list< string >> pgm_args)
Parses the given options and returns a hash of the parsed options; prints out an error message and ex...
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
The GetOpt class provides an easy way to process POSIX-style command-line options in Qore scripts/pro...
Definition: QC_GetOpt.dox.h:6