CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

getopt.h File Reference

Declarations for getopt. More...

Go to the source code of this file.

Compounds

struct  getopt_option
 Describe the long-named options requested by the application. More...


Defines

#define option   getopt_option
 Quirk: so that using the word 'option' in any doxygen comments doesn't create a link to getopt.h. More...


Variables

char * optarg
 For communication from `getopt' to the caller. More...

int optind
 Index in ARGV of the next element to be scanned. More...

int opterr
 Callers store zero here to inhibit the error message `getopt' prints for unrecognized options. More...

int optopt
 Set to an option character which was unrecognized. More...


Detailed Description

Declarations for getopt.

Definition in file getopt.h.


Define Documentation

#define option   getopt_option
 

Quirk: so that using the word 'option' in any doxygen comments doesn't create a link to getopt.h.

Definition at line 106 of file getopt.h.


Variable Documentation

char* optarg
 

For communication from `getopt' to the caller.

When `getopt' finds an option that takes an argument, the argument value is returned here. Also, when `ordering' is RETURN_IN_ORDER, each non-option ARGV-element is returned here.

Definition at line 42 of file getopt.h.

int opterr
 

Callers store zero here to inhibit the error message `getopt' prints for unrecognized options.

Definition at line 61 of file getopt.h.

int optind
 

Index in ARGV of the next element to be scanned.

This is used for communication to and from the caller and for communication between successive calls to `getopt'.

On entry to `getopt', zero means this is the first call; initialize.

When `getopt' returns -1, this is the index of the first of the non-option elements that the caller should itself scan.

Otherwise, `optind' communicates from one call to the next how much of ARGV has been scanned so far.

Definition at line 56 of file getopt.h.

int optopt
 

Set to an option character which was unrecognized.

Definition at line 65 of file getopt.h.


Generated for Crystal Space by doxygen 1.2.14