args.h File Reference

#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/buffer.h>
#include <gwenhywfar/db.h>

Go to the source code of this file.

Data Structures

struct  GWEN_ARGS

Defines

#define GWEN_ARGS_FLAGS_HAS_ARGUMENT   0x00000001
#define GWEN_ARGS_FLAGS_HELP   0x00000004
#define GWEN_ARGS_FLAGS_LAST   0x00000002
#define GWEN_ARGS_MODE_ALLOW_FREEPARAM   0x00000001
#define GWEN_ARGS_MODE_STOP_AT_FREEPARAM   0x00000002
#define GWEN_ARGS_RESULT_ERROR   (-1)
#define GWEN_ARGS_RESULT_HELP   (-2)

Typedefs

typedef GWEN_ARGS GWEN_ARGS

Enumerations

enum  GWEN_ARGS_OUTTYPE { GWEN_ArgsOutType_Txt = 0, GWEN_ArgsOutType_Html }
enum  GWEN_ARGS_TYPE { GWEN_ArgsType_Char = 0, GWEN_ArgsType_Int }

Functions

GWENHYWFAR_API int GWEN_Args_Check (int argc, char **argv, int startAt, GWEN_TYPE_UINT32 mode, const GWEN_ARGS *args, GWEN_DB_NODE *db)
GWENHYWFAR_API int GWEN_Args_ShortUsage (const GWEN_ARGS *args, GWEN_BUFFER *ubuf, GWEN_ARGS_OUTTYPE ot)
GWENHYWFAR_API int GWEN_Args_Usage (const GWEN_ARGS *args, GWEN_BUFFER *ubuf, GWEN_ARGS_OUTTYPE ot)


Define Documentation

#define GWEN_ARGS_FLAGS_HAS_ARGUMENT   0x00000001

#define GWEN_ARGS_FLAGS_HELP   0x00000004

#define GWEN_ARGS_FLAGS_LAST   0x00000002

#define GWEN_ARGS_MODE_ALLOW_FREEPARAM   0x00000001

#define GWEN_ARGS_MODE_STOP_AT_FREEPARAM   0x00000002

#define GWEN_ARGS_RESULT_ERROR   (-1)

#define GWEN_ARGS_RESULT_HELP   (-2)


Typedef Documentation

typedef struct GWEN_ARGS GWEN_ARGS


Enumeration Type Documentation

enum GWEN_ARGS_OUTTYPE

Enumerator:
GWEN_ArgsOutType_Txt 
GWEN_ArgsOutType_Html 

enum GWEN_ARGS_TYPE

Enumerator:
GWEN_ArgsType_Char 
GWEN_ArgsType_Int 


Function Documentation

GWENHYWFAR_API int GWEN_Args_Check ( int  argc,
char **  argv,
int  startAt,
GWEN_TYPE_UINT32  mode,
const GWEN_ARGS args,
GWEN_DB_NODE db 
)

This function parses the given argument list. Known options are stored within the given DB under their respective name. Free parameters (which are arguments without leading "-"'s) are stored in the variable "params" of the given db.

GWENHYWFAR_API int GWEN_Args_ShortUsage ( const GWEN_ARGS args,
GWEN_BUFFER ubuf,
GWEN_ARGS_OUTTYPE  ot 
)

Currently unimplemented; does nothing and returns zero.

GWENHYWFAR_API int GWEN_Args_Usage ( const GWEN_ARGS args,
GWEN_BUFFER ubuf,
GWEN_ARGS_OUTTYPE  ot 
)

Print a "usage" message into the given GWEN_BUFFER ubuf. The message lists all available options. The GWEN_ARGS_OUTTYPE argument is supposed to offer either text or html as output format, but currently only text is implemented.


Generated on Sat Sep 16 11:19:15 2006 for gwenhywfar by  doxygen 1.4.7