Typedefs | |
| typedef _cpl_property_ | cpl_property |
| The opaque property data type. More... | |
Functions | |
| cpl_property * | cpl_property_new (const char *name, cpl_type type) |
| Create an empty property of a given type. More... | |
| cpl_property * | cpl_property_sized_new (const char *name, cpl_type type, int size) |
| Create an empty property of a given type and size. More... | |
| cpl_property * | cpl_property_duplicate (const cpl_property *property) |
| Create a copy of a property. More... | |
| void | cpl_property_delete (cpl_property *property) |
| Destroy a property. More... | |
| long | cpl_property_get_size (cpl_property *property) |
| Get the current number of elements a property contains. More... | |
| long | cpl_property_max_size (cpl_property *property) |
| Get the maximum number of elements possible. More... | |
| cpl_type | cpl_property_get_type (cpl_property *property) |
| Get the type of a property. More... | |
| int | cpl_property_set_name (cpl_property *property, const char *name) |
| Modify the name of a property. More... | |
| int | cpl_property_set_comment (cpl_property *property, const char *comment) |
| Modify a property's comment. More... | |
| int | cpl_property_set_char (cpl_property *property, char value) |
| Set the value of a character property. More... | |
| int | cpl_property_set_bool (cpl_property *property, int value) |
| Set the value of a boolean property. More... | |
| int | cpl_property_set_int (cpl_property *property, int value) |
| Set the value of an integer property. More... | |
| int | cpl_property_set_long (cpl_property *property, long value) |
| Set the value of a long property. More... | |
| int | cpl_property_set_float (cpl_property *property, float value) |
| Set the value of a float property. More... | |
| int | cpl_property_set_double (cpl_property *property, double value) |
| Set the value of a double property. More... | |
| int | cpl_property_set_string (cpl_property *property, const char *value) |
| Set the value of a string property. More... | |
| const char * | cpl_property_get_name (const cpl_property *property) |
| Get the property name. More... | |
| const char * | cpl_property_get_comment (const cpl_property *property) |
| Get the property comment. More... | |
| char | cpl_property_get_char (const cpl_property *property) |
| Get the value of a character property. More... | |
| int | cpl_property_get_bool (const cpl_property *property) |
| Get the value of a boolean property. More... | |
| int | cpl_property_get_int (const cpl_property *property) |
| Get the value of an integer property. More... | |
| long | cpl_property_get_long (const cpl_property *property) |
| Get the value of a long property. More... | |
| float | cpl_property_get_float (const cpl_property *property) |
| Get the value of a float property. More... | |
| double | cpl_property_get_double (const cpl_property *property) |
| Get the value of a double property. More... | |
| const char * | cpl_property_get_string (const cpl_property *property) |
| Get the value of a string property. More... | |
cpl_property is basically a variable container which consists of a name, a type identifier and a specific value of that type. The type identifier always determines the type of the associated value. A property is similar to an ordinary variable and its current value can be set or retrieved through its name. In addition a property may have a descriptive comment associated. A property can be created for the basic types char, bool (int), int, long, float and double. Also C strings are supported. Support for arrays in general is currently not available.#include <cpl_property.h>
|
|
The opaque property data type.
|
|
|
Destroy a property.
|
|
|
Create a copy of a property.
|
|
|
Get the value of a boolean property.
If the property's type is not |
|
|
Get the value of a character property.
If the property's type is not |
|
|
Get the property comment.
|
|
|
Get the value of a double property.
If the property's type is not |
|
|
Get the value of a float property.
If the property's type is not |
|
|
Get the value of an integer property.
If the property's type is not |
|
|
Get the value of a long property.
If the property's type is not |
|
|
Get the property name.
|
|
|
Get the current number of elements a property contains.
CPL_TYPE_STRING, it is the length of the string as given by the strlen() function. |
|
|
Get the value of a string property.
If the property's type is not |
|
|
Get the type of a property.
|
|
|
Get the maximum number of elements possible.
CPL_TYPE_STRING this is the maximum length including the trailing '\0'. |
|
||||||||||||
|
Create an empty property of a given type.
The returned property must be destroyed using the property destructor cpl_property_delete().
|
|
||||||||||||
|
Set the value of a boolean property.
|
|
||||||||||||
|
Set the value of a character property.
|
|
||||||||||||
|
Modify a property's comment.
NULL. In this case the function effectively deletes the current comment. |
|
||||||||||||
|
Set the value of a double property.
|
|
||||||||||||
|
Set the value of a float property.
|
|
||||||||||||
|
Set the value of an integer property.
|
|
||||||||||||
|
Set the value of a long property.
|
|
||||||||||||
|
Modify the name of a property.
NULL. |
|
||||||||||||
|
Set the value of a string property.
|
|
||||||||||||||||
|
Create an empty property of a given type and size.
The returned property must be destroyed using the property destructor cpl_property_delete().
|
1.2.14 written by Dimitri van Heesch,
© 1997-2002