Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

lcmaps_arguments.h File Reference

Public header file to be used by plugins. More...

Go to the source code of this file.

Data Structures

struct  lcmaps_argument_s
 structure representing an LCMAPS plugin run argument. More...


Typedefs

typedef lcmaps_argument_s lcmaps_argument_t
 Type of LCMAPS plugin run argument (to be passed to the plugin by plugin_run()).


Functions

int lcmaps_setArgValue (char *argName, char *argType, void *value, int argcx, lcmaps_argument_t **argvx)
 Set the value of argument with name argName of argType to value. More...

void * lcmaps_getArgValue (char *argName, char *argType, int argcx, lcmaps_argument_t *argvx)
 Get the value of argument with name argName of argType. More...

int lcmaps_findArgName (char *argName, int argcx, lcmaps_argument_t *argvx)
 Get index of argument with name argName. More...

int lcmaps_findArgNameAndType (char *argName, char *argType, int argcx, lcmaps_argument_t *argvx)
 Get index of argument with name argName. More...

int lcmaps_cntArgs (lcmaps_argument_t *argvx)
 Count the number of arguments. More...


Detailed Description

Public header file to be used by plugins.

Author:
Martijn Steenbakkers and Oscar Koeroo for the EU DataGrid.

Routines to access the plugin arguments.

The interface is composed of:

  1. lcmaps_setArgValue(): Set the value of argument with name argName of argType to value
  2. lcmaps_getArgValue(): Get the value of argument with name argName of argType
  3. lcmaps_findArgName(): Get index of argument with name argName
  4. lcmaps_cntArgs(): Count the number of arguments

Definition in file lcmaps_arguments.h.


Function Documentation

lcmaps_cntArgs lcmaps_argument_t   argvx
 

Count the number of arguments.

Count the number of arguments that are defined in a plug-in Returns this number.

Parameters:
argvx  array of arguments structures
Returns:
the number of arguments

Definition at line 273 of file lcmaps_arguments.c.

lcmaps_findArgName char *    argName,
int    argcx,
lcmaps_argument_t   argvx
 

Get index of argument with name argName.

Search for argName in the arguments list. Returns the index to lcmaps_argument_t element.

Parameters:
argName  name of argument
argcx  number of arguments
argvx  array of arguments structures
Returns:
index to lcmaps_argument_t element

Definition at line 179 of file lcmaps_arguments.c.

lcmaps_findArgNameAndType char *    argName,
char *    argType,
int    argcx,
lcmaps_argument_t   argvx
 

Get index of argument with name argName.

Search for argName in the arguments list. Returns the index to lcmaps_argument_t element.

Parameters:
argName  name of argument
argType  type of argument
argcx  number of arguments
argvx  array of arguments structures
Returns:
index to lcmaps_argument_t element

Definition at line 230 of file lcmaps_arguments.c.

lcmaps_getArgValue char *    argName,
char *    argType,
int    argcx,
lcmaps_argument_t   argvx
 

Get the value of argument with name argName of argType.

Set the value of argType on the reserved place in values. The place within values is determined by the place where argName is found in the arguments list Returns a void pointer to the value.

Parameters:
argName  name of argument
argType  type of argument
argcx  number of arguments
argvx  array of arguments structures
Returns:
void pointer to the value or NULL

Definition at line 131 of file lcmaps_arguments.c.

lcmaps_setArgValue char *    argName,
char *    argType,
void *    value,
int    argcx,
lcmaps_argument_t **    argvx
 

Set the value of argument with name argName of argType to value.

Set the value of argType on the reserved place in values. The place within values is determined by the place where argName is found in the arguments list

Parameters:
argName  name of argument
argType  type of argument
argcx  number of arguments
argvx  array of arguments structures
Returns:
0 in case of succes

Definition at line 72 of file lcmaps_arguments.c.


Generated on Sat Oct 2 02:18:27 2004 for edg-lcmaps by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002