Scroll to navigation

BSON_APPEND_VECTOR_FLOAT32_FROM_ARRAY(3) libbson BSON_APPEND_VECTOR_FLOAT32_FROM_ARRAY(3)

SYNOPSIS

#define BSON_APPEND_VECTOR_FLOAT32_FROM_ARRAY(b, key, iter, err) \


   bson_append_vector_float32_from_array (b, key, (int) strlen (key), iter, err)
bool
bson_append_vector_float32_from_array (bson_t *bson,


                                       const char *key,


                                       int key_length,


                                       const bson_iter_t *iter,


                                       bson_error_t *error);


PARAMETERS

  • bson: A bson_t.
  • key: An ASCII C string containing the name of the field.
  • key_length: The length of key in bytes, or -1 to determine the length with strlen().
  • iter: A bson_iter_t referencing array elements that will be converted.
  • error: Optional bson_error_t for detail about conversion failures.

DESCRIPTION

Appends a new field to bson by converting an Array to a Vector of float32 elements.

For the conversion to succeed, every item in the Array must be double-precision floating point number. (BSON_TYPE_DOUBLE)

The provided iter must be positioned just prior to the first element of the BSON Array. If your input is a bare BSON Array, set up iter using bson_iter_init(). If the input is within a document field, use bson_iter_recurse().

RETURNS

Returns true if the operation was applied successfully. On error, returns false and writes additional error information to error without modifying bson. The error will have a domain of BSON_ERROR_VECTOR and a code from bson_vector_error_code_t.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

June 17, 2025 2.0.2