.\" 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_APPEND_SYMBOL" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_append_symbol() \- Appends a new field to bson of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.
.SH "SYNOPSIS"

.nf
.nf
bool
bson_append_symbol (bson_t     *bson,
                    const char *key,
                    int         key_length,
                    const char *value,
                    int         length);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
bson
A
.B bson_t
.
.LP
.TP
.B
key
An ASCII C string containing the name of the field.
.LP
.TP
.B
key_length
The length of
.B key
in bytes, or \(hy1 to determine the length with
.B strlen(3)
.
.LP
.TP
.B
value
The symbol.
.LP
.TP
.B
length
A length of
.B symbol
in bytes, or \(hy1 to determine the length with
.B strlen(3)
.
.LP

.SH "DESCRIPTION"

Appends a new field to
.B bson
of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.

.SH "RETURNS"

true if the operation was applied successfully, otherwise false and
.B bson
should be discarded.


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