Cobalt Framework  beta
Console application support
Classes | Functions
CBOption.h File Reference

Define CBOption class. More...

#include <Coconut/Coconut.h>
#include "CBForwarders.h"

Go to the source code of this file.

Classes

struct  CBOption
 Data representation for command line option. More...

Functions

struct CBOptionCBAllocateOption (unsigned int optid, struct CNResource *resource)
 Allocate command line option.
static void CBReleaseOption (struct CBOption *src)
 Release the object.
static unsigned int CBIdOfOption (const struct CBOption *src)
 Get option id of the option.
void CBAddParameterToOption (struct CBOption *dst, struct CNString *src)
 Add parameter to the option.
static size_t CBCountOfParametersInOption (const struct CBOption *src)
 Get count of parameters in the option.
static struct CNListItem * CBFirstParameterInOption (const struct CBOption *src)
 Get 1st item in the parameter list.

Detailed Description

Define CBOption class.

Copyright
Copyright (C) 2012 Steel Wheels Project

Function Documentation

void CBAddParameterToOption ( struct CBOption dst,
struct CNString *  src 
)

Add parameter to the option.

Parameters:
dstDestination command line option
srcSource parameter for the option
struct CBOption* CBAllocateOption ( unsigned int  optid,
struct CNResource *  resource 
) [read]

Allocate command line option.

Returns:
Allocated object
Parameters:
optidOption id
resourceResource to allocate the option
static size_t CBCountOfParametersInOption ( const struct CBOption src) [inline, static]

Get count of parameters in the option.

Returns:
Count of parameters
Parameters:
srcSource option
static struct CNListItem* CBFirstParameterInOption ( const struct CBOption src) [static, read]

Get 1st item in the parameter list.

Return values:
item1st item in the parameter list
NULLThere are no item in the parameter list
Parameters:
srcSource option
static unsigned int CBIdOfOption ( const struct CBOption src) [inline, static]

Get option id of the option.

Parameters:
srcSource option
static void CBReleaseOption ( struct CBOption src) [inline, static]

Release the object.

Parameters:
srcSource command line option
 All Classes Files Functions Variables Enumerations Enumerator Defines