Click or drag to resize

BsonExtensionMethodsToBson Method (Object, Type, BsonBinaryWriterSettings, IBsonSerializer, ActionBsonSerializationContextBuilder, BsonSerializationArgs)

Serializes an object to a BSON byte array.

Namespace:  MongoDB.Bson
Assembly:  MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
public static byte[] ToBson(
	this Object obj,
	Type nominalType,
	BsonBinaryWriterSettings writerSettings = null,
	IBsonSerializer serializer = null,
	Action<BsonSerializationContextBuilder> configurator = null,
	BsonSerializationArgs args = default
)

Parameters

obj
Type: SystemObject
The object.
nominalType
Type: SystemType
The nominal type of the object..
writerSettings (Optional)
Type: MongoDB.Bson.IOBsonBinaryWriterSettings
The writer settings.
serializer (Optional)
Type: MongoDB.Bson.SerializationIBsonSerializer
The serializer.
configurator (Optional)
Type: SystemActionBsonSerializationContextBuilder
The serialization context configurator.
args (Optional)
Type: MongoDB.Bson.SerializationBsonSerializationArgs
The serialization args.

Return Value

Type: Byte
A BSON byte array.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Object. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentNullExceptionnominalType
ArgumentExceptionserializer
See Also