← Back to branch summary

~ubuntu-branches/ubuntu/utopic/libee/utopic-proposed

« back to all changes in this revision

Viewing changes to include/libee/tagbucket.h

  • Committer: Package Import Robot
  • Author(s): Pierre Chifflier
  • Date: 2011-11-24 22:12:40 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20111124221240-rk8269pzkhair2pk
Tags: 0.3.2-1
* Imported Upstream version 0.3.2
* Update symbols file
* Bump DH version to 8

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/libee/tagbucket.h
6
6
 *//*
7
7
 *
8
8
 * Libee - An Event Expression Library inspired by CEE
9
 
 * Copyright 2010 by Rainer Gerhards and Adiscon GmbH.
 
9
 * Copyright 2010-2011 by Rainer Gerhards and Adiscon GmbH.
10
10
 *
11
11
 * This file is part of libee.
12
12
 *
110
110
 *
111
111
 * @return 0 if tag not present, something else otherwise
112
112
 */
113
 
int ee_BucketHasTag(struct ee_tagbucket *tagbucket, es_str_t *tagname);
 
113
int ee_TagbucketHasTag(struct ee_tagbucket *tagbucket, es_str_t *tagname);
 
114
 
 
115
/**
 
116
 * Iterate over all tags inside a tag bucket.
 
117
 * On initial entry, cookie must be set to zero. The cookie returned
 
118
 * from each call must be passed into the next call. If the returned 
 
119
 * cookie is NULL, no more tags are available (this may happen immediately
 
120
 * if the tag bucket is empty). So the proper terminating condition to
 
121
 * check for is returned cookie == NULL. The actual return code
 
122
 * shall only be check for errors. Note that it is NOT permitted and
 
123
 * can lead to fatal errors if the tagbucket is changed between calls.
 
124
 * If the tagbucket changes, an initial call with a NULL-cookie must be
 
125
 * made.
 
126
 *
 
127
 * @memberof ee_value
 
128
 * @public
 
129
 *
 
130
 * @param[in] tagbucket tagbucket to process
 
131
 * @param[in/out] cookie cookie - for details see description
 
132
 * @param[out] tagname name of tag
 
133
 * @return 0 if tag not present, something else otherwise
 
134
 */
 
135
int ee_TagbucketGetNextTag(struct ee_tagbucket *tagbucket, void **cookie, es_str_t **tagname);
114
136
 
115
137
#endif /* #ifndef LIBEE_TAGBUCKET_H_INCLUDED */