.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "BSON_SET_ERROR" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_set_error() \- This is a helper function to set the parameters of a bson_error_t. It handles the case where error is NULL by doing nothing.
.SH "SYNOPSIS"

.nf
.nf
void
bson_set_error (bson_error_t *error,
                uint32_t      domain,
                uint32_t      code,
                const char   *format,
                ...) BSON_GNUC_PRINTF (4, 5);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
.B error
A
.B bson_error_t
.
.LP
.TP
.B
.B domain
A
.B uint32_t
.
.LP
.TP
.B
.B code
A
.B uint32_t
.
.LP
.TP
.B
.B format
A
.B printf(3)
style format string.
.LP

.SH "DESCRIPTION"

This is a helper function to set the parameters of a
.B bson_error_t
. It handles the case where
.B error
is NULL by doing nothing.


.B
.SH COLOPHON
This page is part of libbson.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.