BSON_VALIDATE_WITH_ERROR(3) libbson BSON_VALIDATE_WITH_ERROR(3) SYNOPSIS bool bson_validate_with_error (const bson_t *bson, bson_validate_flags_t flags, bson_error_t *error); PARAMETERS * bson: A bson_t. * flags: A bitwise-or of all desired bson_validate_flags_t. * error: Optional bson_error_t. 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 para- meter, see bson_validate_flags_t for details. RETURNS If bson passes the requested validations, returns true. Otherwise, returns false and if error is non-NULL it will be filled out with details. The bson_error_t domain is set to BSON_ERROR_INVALID. Its code is set to one of the bson_validate_flags_t flags indicating which validation failed; for example, if a key contains invalid UTF-8, then the code is set to BSON_VALIDATE_UTF8, but if the basic structure of the BSON document is cor- rupt, the code is set to BSON_VALIDATE_NONE. The error message is filled out, and gives more detail if possible. To get the specific location of the error, use bson_validate_with_error_and_offset() instead. SEE ALSO: bson_validate(), bson_validate_with_error_and_offset(). bson_visitor_t can be used for custom validation, Example Custom Validation. AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.8 Aug 27, 2026 BSON_VALIDATE_WITH_ERROR(3)
SYNOPSIS | PARAMETERS | DESCRIPTION | RETURNS | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bson_validate_with_error&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>