Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
BSON_ITER_RECURSE(3)		     libbson		    BSON_ITER_RECURSE(3)

SYNOPSIS
	bool
	bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);

PARAMETERS
     * iter: A bson_iter_t.

     * child: A bson_iter_t.

DESCRIPTION
     The  bson_iter_recurse() function shall initialize child using the embedded
     document or array currently observed by iter.

     If there was a failure to initialize the iter, false is returned  and  both
     iter and child should be considered invalid.

     This  should only be called when observing an element of type BSON_TYPE_AR-
     RAY or BSON_TYPE_DOCUMENT.

RETURNS
     If iter observes an element of type BSON_TYPE_ARRAY or  BSON_TYPE_DOCUMENT,
     then  child  is  initialized  and the function returns true. Otherwise, the
     function returns false and child is invalid.

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026		    BSON_ITER_RECURSE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bson_iter_recurse&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help