Doxygen Documentation

Main Index

Package Index

Package:

CLI

Version:

V0-0-5

Marked:

(not marked)

Constituent:

cli

Tag:

linux-gcc


Interface   Compound List   File List   Compound Members   File Members  

CLI_getValue.c File Reference

Implements the CLI_getValue function. More...

#include <stdio.h>
#include <string.h>
#include "CLI/CLI_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.3 2003/12/12 06:13:49 apw Exp $
Author:
A.P.Waite - apw@slac.stanford.edu

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>


Generated on Thu Dec 11 22:17:31 2003 by doxygen 1.3.3