eurephiadm_functions Struct Reference

#include <commands.h>

Data Fields
char *	command
int	need_session
char *	accesslvl
char *	arghint
char *	helpinfo
void(*	helpfunc )(void)
int(*	function )(eurephiaCTX *, eurephiaSESSION *, eurephiaVALUES *, int argc, char **argv)

---

Detailed Description

struct used for definition of commands, help info and function pointers to the command

Definition at line 41 of file commands.h.

---

Field Documentation

char* eurephiadm_functions::accesslvl

String containing the access level the user need to use this command

Definition at line 44 of file commands.h.

char* eurephiadm_functions::arghint

Simple help hints string, used in the main help screen mainly

Definition at line 45 of file commands.h.

char* eurephiadm_functions::command

Command name, which is used by the end user

Definition at line 42 of file commands.h.

int(* eurephiadm_functions::function)(eurephiaCTX *, eurephiaSESSION *, eurephiaVALUES *, int argc, char **argv)

Commands main entry function. This function will be called when a valid function is found

Parameters:

	eurephiaCTX*	The current eurephiaCTX will be received here.
	eurephiaSESSION*	The current eurephiaSESSION for the logged in user.
	argc	argument counter of all following arguments.
	argv	argument vector, char * array of all arguments. arg[0] is the command itself.

Returns:

The function must return 0 on success, and a value > 0 on errors.

Definition at line 57 of file commands.h.

void(* eurephiadm_functions::helpfunc)(void)

Function pointer to the help function. Takes no arguments

Definition at line 47 of file commands.h.

char* eurephiadm_functions::helpinfo

Simple one-line help string describing the command

Definition at line 46 of file commands.h.

int eurephiadm_functions::need_session

Set this flag to 1, if the user must log in to use this command

Definition at line 43 of file commands.h.

---

The documentation for this struct was generated from the following file:

• eurephiadm/commands.h