Document return values
[ACE_TAO.git] / ACE / ace / Get_Opt.inl
blob950d707ec984ca6c484265563af651f9b4b31481
1 // -*- C++ -*-
2 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
4 ACE_INLINE bool
5 ACE_Get_Opt::ACE_Get_Opt_Long_Option::operator < (const ACE_Get_Opt_Long_Option &rhs)
7   return this->name_ < rhs.name_;
10 ACE_INLINE int
11 ACE_Get_Opt::argc () const
13   return this->argc_;
16 ACE_INLINE ACE_TCHAR **
17 ACE_Get_Opt::argv () const
19   return this->argv_;
22 ACE_INLINE ACE_TCHAR*
23 ACE_Get_Opt::opt_arg () const
25   return this->optarg;
28 ACE_INLINE int
29 ACE_Get_Opt::opt_opt ()
31   return this->optopt_;
34 ACE_INLINE int &
35 ACE_Get_Opt::opt_ind ()
37   return this->optind;
40 #ifdef ACE_USES_WCHAR
41 ACE_INLINE  ACE_Get_Opt::ACE_Get_Opt (int argc,
42                ACE_TCHAR **argv,
43                const ACE_TCHAR *optstring,
44                int skip_args,
45                int report_errors,
46                int ordering,
47                int long_only)
48   : argc_ (argc),
49     argv_ (argv),
50     optind (skip_args),
51     opterr (report_errors),
52     optarg (0),
53     optstring_ (0),
54     long_only_ (long_only),
55     has_colon_ (0),
56     last_option_ (0),
57     nextchar_ (0),
58     optopt_ (0),
59     ordering_ (ordering),
60     nonopt_start_ (optind),
61     nonopt_end_ (optind),
62     long_option_ (0)
64   ACE_Get_Opt_Init (optstring);
67 ACE_INLINE  ACE_Get_Opt::ACE_Get_Opt (int argc,
68                ACE_TCHAR **argv,
69                const char *optstring,
70                int skip_args,
71                int report_errors,
72                int ordering,
73                int long_only)
74   : argc_ (argc),
75     argv_ (argv),
76     optind (skip_args),
77     opterr (report_errors),
78     optarg (0),
79     optstring_ (),
80     long_only_ (long_only),
81     has_colon_ (0),
82     last_option_ (0),
83     nextchar_ (0),
84     optopt_ (0),
85     ordering_ (ordering),
86     nonopt_start_ (optind),
87     nonopt_end_ (optind),
88     long_option_ (0)
90   ACE_Get_Opt_Init (ACE_TEXT_CHAR_TO_TCHAR (optstring));
92 #endif
94 ACE_END_VERSIONED_NAMESPACE_DECL