Typedefs | |
| typedef _cpl_parlist_ | cpl_parlist |
| The opaque parameter list data type. More... | |
Functions | |
| cpl_parlist * | cpl_parlist_new (void) |
| Create a new parameter list. More... | |
| void | cpl_parlist_delete (cpl_parlist *list) |
| Destroy a parameter list. More... | |
| int | cpl_parlist_get_size (cpl_parlist *list) |
| Get the current size of a property list. More... | |
| void | cpl_parlist_append (cpl_parlist *list, cpl_parameter *parameter) |
| Append a parameter to a parameter list. More... | |
| cpl_parameter * | cpl_parlist_begin (cpl_parlist *list) |
| Get the first parameter inthe given parameter list. More... | |
| cpl_parameter * | cpl_parlist_next (cpl_parlist *list) |
| Get the next parameter in the given list. More... | |
| cpl_parameter * | cpl_parlist_end (cpl_parlist *list) |
| Get the last parameter in the given list. More... | |
| cpl_parameter * | cpl_parlist_find (cpl_parlist *list, const char *name) |
| Find a parameter with the given name in a parameter list. More... | |
| cpl_parameter * | cpl_parlist_find_type (cpl_parlist *list, cpl_type type) |
| Find a parameter of the given type in a parameter list. More... | |
| cpl_parameter * | cpl_parlist_find_context (cpl_parlist *list, const char *context) |
| Find a parameter which belongs to the given context in a parameter list. More... | |
| cpl_parameter * | cpl_parlist_find_tag (cpl_parlist *list, const char *tag) |
| Find a parameter with the given tag in a parameter list. More... | |
| void | cpl_parlist_print (cpl_parlist *list) |
| Print all parameters in the given parameter list. More... | |
It is used in the plugin interface (cf. Plugin Interface), for instance, to pass the parameters a recipe accepts from the plugin to the calling application and vice versa.
All functions expect a valid pointer to a parameter list as input, unless otherwise specified.
#include <cpl_parlist.h>
|
|
The opaque parameter list data type.
|
|
||||||||||||
|
Append a parameter to a parameter list.
|
|
|
Get the first parameter inthe given parameter list.
NULL is returned. The function updates the internal search position cache. |
|
|
Destroy a parameter list.
|
|
|
Get the last parameter in the given list.
|
|
||||||||||||
|
Find a parameter with the given name in a parameter list.
NULL. |
|
||||||||||||
|
Find a parameter which belongs to the given context in a parameter list.
NULL. |
|
||||||||||||
|
Find a parameter with the given tag in a parameter list.
NULL. |
|
||||||||||||
|
Find a parameter of the given type in a parameter list.
NULL. |
|
|
Get the current size of a property list.
|
|
|
Create a new parameter list.
|
|
|
Get the next parameter in the given list.
NULL otherwise. The function uses the last cached search position to determine the most recently accessed parameter. This means that the function only works as expected if the list has been initialised by a call to cpl_parlist_begin(), and if no function updating the internal cache was called between two subsequent calls to this function. |
|
|
Print all parameters in the given parameter list.
|
1.2.14 written by Dimitri van Heesch,
© 1997-2002