This is an outdated version of the documentation. See the current version of this page.
Contents Menu Expand Light mode Dark mode Auto light/dark mode
libbson 1.25.1
libbson 1.25.1
  • Tutorial
    • Using libbson In Your C Program
    • Creating a BSON Document
    • Handling Errors
    • ObjectIDs
    • Parsing and Iterating BSON Documents
    • UTF-8
  • Guides
    • Streaming BSON
    • JSON
  • Cross Platform Notes
    • Endianness
    • Threading
  • API Reference
    • bson_t
      • bson_append_array()
      • bson_append_array_begin()
      • bson_append_array_end()
      • bson_append_binary()
      • bson_append_bool()
      • bson_append_code()
      • bson_append_code_with_scope()
      • bson_append_date_time()
      • bson_append_dbpointer()
      • bson_append_decimal128()
      • bson_append_document()
      • bson_append_document_begin()
      • bson_append_document_end()
      • bson_append_double()
      • bson_append_int32()
      • bson_append_int64()
      • bson_append_iter()
      • bson_append_maxkey()
      • bson_append_minkey()
      • bson_append_now_utc()
      • bson_append_null()
      • bson_append_oid()
      • bson_append_regex()
      • bson_append_regex_w_len()
      • bson_append_symbol()
      • bson_append_time_t()
      • bson_append_timestamp()
      • bson_append_timeval()
      • bson_append_undefined()
      • bson_append_utf8()
      • bson_append_value()
      • bson_array_as_canonical_extended_json()
      • bson_array_as_json()
      • bson_array_as_relaxed_extended_json()
      • bson_as_canonical_extended_json()
      • bson_as_json()
      • bson_as_json_with_opts()
      • bson_as_relaxed_extended_json()
      • bson_compare()
      • bson_concat()
      • bson_copy()
      • bson_copy_to()
      • bson_copy_to_excluding()
      • bson_copy_to_excluding_noinit()
      • bson_copy_to_excluding_noinit_va()
      • bson_count_keys()
      • bson_destroy()
      • bson_destroy_with_steal()
      • bson_equal()
      • bson_get_data()
      • bson_has_field()
      • bson_init()
      • bson_init_from_json()
      • bson_init_static()
      • bson_json_mode_t
      • bson_json_opts_t
        • bson_json_opts_new()
        • bson_json_opts_destroy()
        • bson_json_opts_set_outermost_array()
      • bson_new()
      • bson_new_from_buffer()
      • bson_new_from_data()
      • bson_new_from_json()
      • bson_reinit()
      • bson_reserve_buffer()
      • bson_sized_new()
      • bson_steal()
      • bson_validate()
      • bson_validate_with_error()
    • bson_array_builder_t
    • bson_context_t
      • bson_context_destroy()
      • bson_context_get_default()
      • bson_context_new()
    • bson_decimal128_t
      • bson_decimal128_from_string()
      • bson_decimal128_from_string_w_len()
      • bson_decimal128_to_string()
    • bson_error_t
      • bson_set_error()
      • bson_strerror_r()
    • bson_iter_t
      • bson_iter_array()
      • bson_iter_as_bool()
      • bson_iter_as_double()
      • bson_iter_as_int64()
      • bson_iter_binary()
      • bson_iter_bool()
      • bson_iter_code()
      • bson_iter_codewscope()
      • bson_iter_date_time()
      • bson_iter_dbpointer()
      • bson_iter_decimal128()
      • bson_iter_document()
      • bson_iter_double()
      • bson_iter_dup_utf8()
      • bson_iter_find()
      • bson_iter_find_case()
      • bson_iter_find_descendant()
      • bson_iter_find_w_len()
      • bson_iter_init()
      • bson_iter_init_find()
      • bson_iter_init_find_case()
      • bson_iter_init_find_w_len()
      • bson_iter_init_from_data()
      • bson_iter_init_from_data_at_offset()
      • bson_iter_int32()
      • bson_iter_int64()
      • bson_iter_key()
      • bson_iter_key_len()
      • bson_iter_next()
      • bson_iter_offset()
      • bson_iter_oid()
      • bson_iter_overwrite_bool()
      • bson_iter_overwrite_date_time()
      • bson_iter_overwrite_decimal128()
      • bson_iter_overwrite_double()
      • bson_iter_overwrite_int32()
      • bson_iter_overwrite_int64()
      • bson_iter_overwrite_oid()
      • bson_iter_overwrite_timestamp()
      • bson_iter_recurse()
      • bson_iter_regex()
      • bson_iter_symbol()
      • bson_iter_time_t()
      • bson_iter_timestamp()
      • bson_iter_timeval()
      • bson_iter_type()
      • bson_iter_utf8()
      • bson_iter_value()
      • bson_iter_visit_all()
    • bson_json_reader_t
      • bson_json_data_reader_ingest()
      • bson_json_data_reader_new()
      • bson_json_reader_destroy()
      • bson_json_reader_new()
      • bson_json_reader_new_from_fd()
      • bson_json_reader_new_from_file()
      • bson_json_reader_read()
    • bson_oid_t
      • bson_oid_compare()
      • bson_oid_compare_unsafe()
      • bson_oid_copy()
      • bson_oid_copy_unsafe()
      • bson_oid_equal()
      • bson_oid_equal_unsafe()
      • bson_oid_get_time_t()
      • bson_oid_get_time_t_unsafe()
      • bson_oid_hash()
      • bson_oid_hash_unsafe()
      • bson_oid_init()
      • bson_oid_init_from_data()
      • bson_oid_init_from_string()
      • bson_oid_init_from_string_unsafe()
      • bson_oid_init_sequence()
      • bson_oid_is_valid()
      • bson_oid_to_string()
    • bson_reader_t
      • bson_reader_destroy()
      • bson_reader_destroy_func_t
      • bson_reader_new_from_data()
      • bson_reader_new_from_fd()
      • bson_reader_new_from_file()
      • bson_reader_new_from_handle()
      • bson_reader_read()
      • bson_reader_read_func_t
      • bson_reader_reset()
      • bson_reader_set_destroy_func()
      • bson_reader_set_read_func()
      • bson_reader_tell()
    • Character and String Routines
      • bson_ascii_strtoll()
      • bson_isspace()
      • bson_snprintf()
      • bson_strcasecmp()
      • bson_strdup()
      • bson_strdup_printf()
      • bson_strdupv_printf()
      • bson_strfreev()
      • bson_strncpy()
      • bson_strndup()
      • bson_strnlen()
      • bson_uint32_to_string()
      • bson_utf8_escape_for_json()
      • bson_utf8_from_unichar()
      • bson_utf8_get_char()
      • bson_utf8_next_char()
      • bson_utf8_validate()
      • bson_vsnprintf()
    • bson_string_t
      • bson_string_append()
      • bson_string_append_c()
      • bson_string_append_printf()
      • bson_string_append_unichar()
      • bson_string_free()
      • bson_string_new()
      • bson_string_truncate()
    • bson_subtype_t
    • bson_type_t
    • bson_unichar_t
    • bson_value_t
      • bson_value_copy()
      • bson_value_destroy()
    • bson_visitor_t
    • bson_writer_t
      • bson_writer_begin()
      • bson_writer_destroy()
      • bson_writer_end()
      • bson_writer_get_length()
      • bson_writer_new()
      • bson_writer_rollback()
    • System Clock
    • Memory Management
      • bson_free()
      • bson_malloc()
      • bson_malloc0()
      • bson_aligned_alloc()
      • bson_aligned_alloc0()
      • bson_mem_restore_vtable()
      • bson_mem_set_vtable()
      • bson_realloc()
      • bson_realloc_ctx()
      • bson_realloc_func
      • bson_zero_free()
    • Libbson Versioning
      • bson_check_version()
      • bson_get_major_version()
      • bson_get_micro_version()
      • bson_get_minor_version()
      • bson_get_version()
Back to top

bson_iter_init_find()#

Synopsis#

bool
bson_iter_init_find (bson_iter_t *iter, const bson_t *bson, const char *key);

Parameters#

  • iter: A bson_iter_t.

  • bson: A bson_t.

  • key: A key to locate after initializing the iter.

Description#

This function is identical to (bson_iter_init() && bson_iter_find()).

See also

bson_iter_init()
bson_iter_init_find()
bson_iter_init_find_case()
bson_iter_init_from_data()
Next
bson_iter_init_find_case()
Previous
bson_iter_init()
Copyright © 2017-present, MongoDB, Inc
Made with Sphinx and @pradyunsg's Furo
On this page
  • bson_iter_init_find()
    • Synopsis
    • Parameters
    • Description