CLI_getValue.c File Reference

Implements the CLI_getValue function. More...

#include <stdio.h>
#include <string.h>
#include <CLI/CLI_msgs.h>
#include <CLI/CLI_pubdefs.h>
#include <MDB/MDB_pubdefs.h>
#include <CLI_prvdefs.h>

Functions
unsigned int	CLI_getValue (const CLI_Control *ctl, const char *text, const char **valu)
	Return the value of some object.

---

Detailed Description

Implements the CLI_getValue function.

CVS $Id: CLI_getValue.c,v 1.5 2011/03/25 00:51:25 apw Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int CLI_getValue	(	const CLI_Control *	ctl,
		const char *	text,
		const char **	valu
	)

Return the value of some object.

Parameters:

	ctl	(Opaque) pointer to CLI control structure
	text	Text (name) of object to fetch
	valu	Returned value

Return values:

	CLI_ABSENT	No value found
	CLI_COMMA	Another value available
	CLI_NOTCTL	(Opaque) pointer does not point to CLI control structure
	CLI_SUCCESS	Value returned (and end of list if a list exists)

CLI_getValue is the one and only fetch command for parameters, qualifiers and some special cases. The table is as follows:

String	Returns
$line	Original command line
$verb	Verb from command line
$<n>	Value of parameter <n> (starting at zero)
<qualifier>	Value of qualifier <qualifier>

References _CLI_Qual::curr, _CLI_Parm::curr, _CLI_Control::id, _CLI_Tokens::line, _CLI_Qual::list, _CLI_Parm::list, _CLI_Qual::next, _CLI_Valu::next, _CLI_Parm::next, _CLI_Tokens::parm, _CLI_Tokens::qual, _CLI_Qual::text, _CLI_Valu::text, _CLI_Control::tokens, and _CLI_Tokens::verb.

Referenced by CLI_indirect().