Click or drag to resize

BsonExtensionMethods.ToBson Method (Object, Type, BsonBinaryWriterSettings, IBsonSerializer, Action<BsonSerializationContext.Builder>, BsonSerializationArgs)

Serializes an object to a BSON byte array.

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

Parameters

obj
Type: System.Object
The object.
nominalType
Type: System.Type
The nominal type of the object..
writerSettings (Optional)
Type: MongoDB.Bson.IO.BsonBinaryWriterSettings
The writer settings.
serializer (Optional)
Type: MongoDB.Bson.Serialization.IBsonSerializer
The serializer.
configurator (Optional)
Type: System.Action<BsonSerializationContext.Builder>
The serialization context configurator.
args (Optional)
Type: MongoDB.Bson.Serialization.BsonSerializationArgs
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