BsonExtensionMethods.ToBson Method (Object, Type, BsonBinaryWriterSettings, IBsonSerializer, Action<BsonSerializationContext.Builder>, BsonSerializationArgs, Int32) |
Serializes an object to a BSON byte array.
Namespace:
MongoDB.Bson
Assembly:
MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntaxpublic static byte[] ToBson(
this Object obj,
Type nominalType,
BsonBinaryWriterSettings writerSettings = null,
IBsonSerializer serializer = null,
Action<BsonSerializationContext.Builder> configurator = null,
BsonSerializationArgs args = default,
int estimatedBsonSize = 0
)
<ExtensionAttribute>
Public Shared Function ToBson (
obj As Object,
nominalType As Type,
Optional writerSettings As BsonBinaryWriterSettings = Nothing,
Optional serializer As IBsonSerializer = Nothing,
Optional configurator As Action(Of BsonSerializationContext.Builder) = Nothing,
Optional args As BsonSerializationArgs = Nothing,
Optional estimatedBsonSize As Integer = 0
) As Byte()
[<ExtensionAttribute>]
static member ToBson :
obj : Object *
nominalType : Type *
?writerSettings : BsonBinaryWriterSettings *
?serializer : IBsonSerializer *
?configurator : Action<BsonSerializationContext.Builder> *
?args : BsonSerializationArgs *
?estimatedBsonSize : int
(* Defaults:
let _writerSettings = defaultArg writerSettings null
let _serializer = defaultArg serializer null
let _configurator = defaultArg configurator null
let _args = defaultArg args new BsonSerializationArgs()
let _estimatedBsonSize = defaultArg estimatedBsonSize 0
*)
-> byte[]
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. - estimatedBsonSize (Optional)
- Type: System.Int32
The estimated size of the serialized object.
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
See Also