From 56f024f457b16219d512810ab1861c6c4482b516 Mon Sep 17 00:00:00 2001 From: Michal Privoznik Date: Fri, 6 Sep 2019 13:50:39 +0200 Subject: [PATCH] virdomainobjlist: Document virDomainObjListForEach() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Privoznik Reviewed-by: Ján Tomko --- src/conf/virdomainobjlist.c | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/conf/virdomainobjlist.c b/src/conf/virdomainobjlist.c index d640da6205..11fd68745b 100644 --- a/src/conf/virdomainobjlist.c +++ b/src/conf/virdomainobjlist.c @@ -815,6 +815,19 @@ virDomainObjListHelper(void *payload, } +/** + * virDomainObjListForEach: + * @doms: Pointer to the domain object list + * @callback: callback to run over each domain on the list + * @opaque: opaque data to pass to @callback + * + * For every domain on the list (@doms) run @callback on it. If + * @callback fails (i.e. returns a negative value), the iteration + * carries still on until all domains are visited. + * + * Returns: 0 on success, + * -1 otherwise. + */ int virDomainObjListForEach(virDomainObjListPtr doms, virDomainObjListIterator callback, -- GitLab