IBsonIdProvider.GetDocumentId Method (original) (raw)

IBsonIdProviderGetDocumentId Method

Gets the document Id.

Namespace: MongoDB.Bson.Serialization
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

bool GetDocumentId( Object document, out Object id, out Type idNominalType, out IIdGenerator idGenerator )

Function GetDocumentId ( document As Object, ByRef id As Object, ByRef idNominalType As Type, ByRef idGenerator As IIdGenerator ) As Boolean

abstract GetDocumentId : document : Object * id : Object byref * idNominalType : Type byref * idGenerator : IIdGenerator byref -> bool

Parameters

document

Type: SystemObject
The document.

id

Type: SystemObject
The Id.

idNominalType

Type: SystemType
The nominal type of the Id.

idGenerator

Type: MongoDB.Bson.SerializationIIdGenerator
The IdGenerator for the Id type.

Return Value

Type: Boolean
True if the document has an Id.

See Also

Reference