summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stef@thewalter.net>2013-07-16 17:18:02 +0200
committerStef Walter <stef@thewalter.net>2013-07-18 06:53:31 +0200
commitb2e6bc0ea2b2d2b90f6a159a23a4e676b1f302e4 (patch)
tree4b635af04a543aa79d95507c849abcb025f0745a
parent3f9da410144fd45ee6250dda28cae49300077e29 (diff)
iter: Document guarantees for filter matches argumet
The matches argument is always initialized to CK_TRUE when a filter is called, and it's up to filters to set it to CK_FALSE. Filters don't need to set to CK_TRUE. https://bugzilla.redhat.com/show_bug.cgi?id=985009
-rw-r--r--p11-kit/iter.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/p11-kit/iter.c b/p11-kit/iter.c
index 9c22ee0..a59944a 100644
--- a/p11-kit/iter.c
+++ b/p11-kit/iter.c
@@ -220,6 +220,10 @@ p11_kit_iter_set_session_flags (P11KitIter *iter,
* indicates through it's <literal>matches</literal> argument that
* the object should not match, then that object will not be iterated
* as far as p11_kit_iter_next() is concerned.
+ *
+ * The callbacks will be called with the <literal>matches</literal>
+ * set to <literal>CK_TRUE</literal> and it's up to filters to change
+ * it to <literal>CK_FALSE</literal> when necessary.
*/
void
p11_kit_iter_add_callback (P11KitIter *iter,