Scroll to navigation

BSON_VALIDATE(3) Libbson BSON_VALIDATE(3)

NAME

bson_validate - bson_validate()

SYNOPSIS

bool
bson_validate (const bson_t *bson, bson_validate_flags_t flags, size_t *offset);


PARAMETERS

  • bson: A bson_t.
  • flags: A bitwise-or of all desired bson_validate_flags_t.
  • offset: A location for the offset within bson where the error occurred.

DESCRIPTION

Validates a BSON document by walking through the document and inspecting the keys and values for valid content.

You can modify how the validation occurs through the use of the flags parameter, see bson_validate_with_error() for details.

SEE ALSO

bson_validate_with_error().

bson_visitor_t can be used for custom validation, example_custom_validation.

RETURNS

Returns true if bson is valid; otherwise false and offset is set to the byte offset where the error was detected.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc
November 7, 2019 1.15.2