| Top |  |  |  |  | 
| int | idmef_path_get () | 
| int | idmef_path_set () | 
| int | idmef_path_new () | 
| int | idmef_path_new_v () | 
| int | idmef_path_new_fast () | 
| idmef_class_id_t | idmef_path_get_class () | 
| idmef_value_type_id_t | idmef_path_get_value_type () | 
| int | idmef_path_set_index () | 
| int | idmef_path_undefine_index () | 
| int | idmef_path_get_index () | 
| int | idmef_path_make_child () | 
| int | idmef_path_make_parent () | 
| void | idmef_path_destroy () | 
| int | idmef_path_ncompare () | 
| int | idmef_path_compare () | 
| int | idmef_path_clone () | 
| idmef_path_t * | idmef_path_ref () | 
| const char * | idmef_path_get_name () | 
| prelude_bool_t | idmef_path_is_ambiguous () | 
| int | idmef_path_has_lists () | 
| prelude_bool_t | idmef_path_is_list () | 
| unsigned int | idmef_path_get_depth () | 
| int | idmef_path_check_operator () | 
| int | idmef_path_get_applicable_operators () | 
int idmef_path_get (const idmef_path_t *path,void *object,idmef_value_t **ret);
This function retrieves the value for path
 within message
,
and stores it into the provided ret
 address of type idmef_value_t.
| path | Pointer to a idmef_path_t object. | |
| obj | Pointer to a idmef_object_t object. | |
| ret | Address where to store the retrieved idmef_value_t. | 
int idmef_path_set (const idmef_path_t *path,void *object,idmef_value_t *value);
This function sets the provided value
 for path
 within message
.
| path | Pointer to a idmef_path_t object. | |
| obj | Pointer to a idmef_object_t object. | |
| value | Pointer to a idmef_value_t object. | 
int idmef_path_new (idmef_path_t **path,const char *format);
Creates an idmef_path_t object pointing to the provided format
string format
 and @..., and stores it within path
.
| path | Address where to store the created idmef_path_t object. | |
| format | Format string. | |
| ... | Arguments list. | 
int idmef_path_new_v (idmef_path_t **path,const char *format);
Creates an idmef_path_t object pointing to the provided format
string format
 and args
, and stores it within path
.
| path | Address where to store the created idmef_path_t object. | |
| format | Format string. | |
| args | Pointer to a variable argument list. | 
int idmef_path_new_fast (idmef_path_t **path,const char *buffer);
Creates a idmef_path_t object pointing to buffer
, and stores it within path
.
| path | Address where to store the created idmef_path_t object. | |
| buffer | Name of the path to create. | 
idmef_class_id_t idmef_path_get_class (const idmef_path_t *path,int depth);
Retrieves the idmef_class_id_t value for the element of path
located at depth
. If depth is -1, the last element depth is addressed.
| path | Pointer to an idmef_path_t object. | |
| depth | Depth of  | 
idmef_value_type_id_t idmef_path_get_value_type (const idmef_path_t *path,int depth);
Retrieves the idmef_value_type_id_t identifying the type of value
acceptable for this path element, for the path
 element located at
depth
. If depth is -1, the last element depth is addressed.
| path | Pointer to an idmef_path_t object. | |
| depth | Depth of  | 
int idmef_path_set_index (idmef_path_t *path,unsigned int depth,int index);
Modifies index
 for the element located at depth
 of provided path
.
This function is only applicable for element that accept listed value.
| path | Pointer to an idmef_path_t object. | |
| depth | Depth of  | |
| index | Index for the provided element  | 
int idmef_path_undefine_index (idmef_path_t *path,unsigned int depth);
Modifies the element located at depth
 of provided path
 so that it's
index is undefined.
This function is only applicable for element that accept listed value.
int idmef_path_get_index (const idmef_path_t *path,unsigned int depth);
Gets the current index for element located at depth
 of path
.
This function is only applicable for element that accepts listed value.
int idmef_path_make_child (idmef_path_t *path,const char *child_name,int index);
Modifies path
 so that it points to the child node identified by child_name
,
children of the current path. That is if the path is currently pointing to
alert.classification, and child_name
 is set to "text", path
 will be
modified to point to alert.classification.text.
| path | Pointer to an idmef_path_t object. | |
| child_name | Name of the child element to create. | |
| index | Index for  | 
int
idmef_path_make_parent (idmef_path_t *path);
Removes the last element of the path. That is, if path
 is currently pointing to
alert.classification, path
 will be modified to point to alert.
void
idmef_path_destroy (idmef_path_t *path);
Destroys the provided path
 object.
int idmef_path_ncompare (const idmef_path_t *p1,const idmef_path_t *p2,unsigned int depth);
Compares p1
 and p2
 elements up to depth
.
| p1 | Pointer to an idmef_path_t object. | |
| p2 | Pointer to another idmef_path_t object. | |
| depth | Maximum depth to use for path comparison. | 
int idmef_path_compare (const idmef_path_t *p1,const idmef_path_t *p2);
Compares p1
 and p2
 elements.
int idmef_path_clone (const idmef_path_t *src,idmef_path_t **dst);
Clones src
 and stores the result in the provided dst
 address.
idmef_path_t *
idmef_path_ref (idmef_path_t *path);
Increases path
 reference count.
idmef_path_destroy() will destroy the refcount until it reaches 0, at which point the path will be destroyed.
const char * idmef_path_get_name (const idmef_path_t *path,int depth);
Returns the full path name if the provided depth
 is -1, or the specific
element name if depth is set. That is, for a path
 pointing to
"alert.classification.text": A depth of -1 would return "alert.classification.text";
a depth of 0 would return "alert"; a depth of 1 would return "classification"; and
a depth of 2 would return "text".
| path | Pointer to an idmef_path_t object. | |
| depth | Depth of the  | 
prelude_bool_t
idmef_path_is_ambiguous (const idmef_path_t *path);
Returns TRUE if path
 contain elements that are supposed
to be listed, but for which no index were provided.
int idmef_path_check_operator (const idmef_path_t *path,idmef_criterion_operator_t op);
Check whether op
 can apply to value pointed to by path
.
int idmef_path_get_applicable_operators (const idmef_path_t *path,idmef_criterion_operator_t *result);
Retrieve all applicable operator that might be used by the type of
value pointed to by path
.
| path | Pointer to a idmef_path_t object. | |
| result | Pointer to storage for applicable operator. |