Products Support Documentation Download
rdmcmdlineapi.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * Raima Database Manager
3  *
4  * Copyright (c) 2014 Raima Inc., All rights reserved.
5  *
6  * Use of this software, whether in source code format, or in executable,
7  * binary object code form, is governed by the Raima LICENSE which
8  * is fully described in the LICENSE.TXT file, included within this
9  * distribution of files.
10  * ----------------------------------------------------------------------------
11  */
12 
17 #include "rdmcmdlinetypes.h"
18 #include "rdmretcodetypes.h"
19 
20 #if defined(__cplusplus)
21 extern "C" {
22 #endif
23 
50 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_cmdlineInit (
51  RDM_CMDLINE *
52  cmd,
53  int32_t argc,
54  const char *const argv[],
56  const char *description,
57  const RDM_CMDLINE_OPT *
58  opts
59 );
60 
73 RDM_EXPORT const char *EXTERNAL_FCN rdm_cmdlineNextLongOption (
74  RDM_CMDLINE *cmd,
76  const char *
77  *arg
80 );
81 
97 RDM_EXPORT char EXTERNAL_FCN rdm_cmdlineNextShortOption (
98  RDM_CMDLINE *cmd,
100  const char *
101  *arg
104 );
105 
107 #if defined(__cplusplus)
108 }
109 #endif
Header for command line parsing types.
RDM Status and Error Return Codes.
The buffer used by the command line parser to hold state information.
RDM_RETCODE
RDM status and error return codes.
RDM_RETCODE rdm_cmdlineInit(RDM_CMDLINE *cmd, int32_t argc, const char *const argv[], const char *description, const RDM_CMDLINE_OPT *opts)
Initialize an RDM_CMDLINE buffer and validate the command line.
Generic usage function option record.
const char * rdm_cmdlineNextLongOption(RDM_CMDLINE *cmd, const char **arg)
Get next option or argument.
char rdm_cmdlineNextShortOption(RDM_CMDLINE *cmd, const char **arg)
Get next option or argument.