Typedefs | |
typedef _cpl_parameterlist_ | cpl_parameterlist |
The opaque parameter list data type. | |
Functions | |
cpl_parameterlist * | cpl_parameterlist_new (void) |
Create a new parameter list. | |
void | cpl_parameterlist_delete (cpl_parameterlist *self) |
Destroy a parameter list. | |
int | cpl_parameterlist_get_size (const cpl_parameterlist *self) |
Get the current size of a property list. | |
cpl_error_code | cpl_parameterlist_append (cpl_parameterlist *self, cpl_parameter *parameter) |
Append a parameter to a parameter list. | |
cpl_parameter * | cpl_parameterlist_get_first (cpl_parameterlist *self) |
Get the first parameter in the given parameter list. | |
cpl_parameter * | cpl_parameterlist_get_next (cpl_parameterlist *self) |
Get the next parameter in the given list. | |
cpl_parameter * | cpl_parameterlist_get_last (cpl_parameterlist *self) |
Get the last parameter in the given list. | |
cpl_parameter * | cpl_parameterlist_find (cpl_parameterlist *self, const char *name) |
Find a parameter with the given name in a parameter list. | |
cpl_parameter * | cpl_parameterlist_find_type (cpl_parameterlist *self, cpl_type type) |
Find a parameter of the given type in a parameter list. | |
cpl_parameter * | cpl_parameterlist_find_context (cpl_parameterlist *self, const char *context) |
Find a parameter which belongs to the given context in a parameter list. | |
cpl_parameter * | cpl_parameterlist_find_tag (cpl_parameterlist *self, const char *tag) |
Find a parameter with the given tag in a parameter list. | |
void | cpl_parameterlist_dump (const cpl_parameterlist *self, FILE *stream) |
Dump the contents of a parameter list to the given stream. |
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_parameterlist.h>
|
The opaque parameter list data type.
|
|
Append a parameter to a parameter list.
The parameter parameter is appended to the parameter list self. |
|
Destroy a parameter list.
|
|
Dump the contents of a parameter list to the given stream.
NULL the function does nothing.
|
|
Find a parameter with the given name in a parameter list.
The function searches the parameter list self for the first occurrence of a parameter with the fully qualified name name. If no parameter with this name exists, the function returns |
|
Find a parameter which belongs to the given context in a parameter list.
The function searches the parameter list self for the first occurrence of a parameter which belongs to the context context. If no parameter with this type exists, the function returns |
|
Find a parameter with the given tag in a parameter list.
The function searches the parameter list self for the first occurrence of a parameter with the user tag tag. If no parameter with this tag exists, the function returns |
|
Find a parameter of the given type in a parameter list.
The function searches the parameter list self for the first occurrence of a parameter whose value is of the type type. If no parameter with this type exists, the function returns |
|
Get the first parameter in the given parameter list.
The function returns the first parameter in the parameter list self, if it exists. If there is no first parameter, i.e. if the list is empty, |
|
Get the last parameter in the given list.
The function returns the last parameter stored in the parameter list self. The list self must not be empty. |
|
Get the next parameter in the given list.
The function returns the next parameter in the parameter list self if it exists and |
|
Get the current size of a property list.
The function reports the current number of elements stored in the parameter list self. |
|
Create a new parameter list.
|