DeleteDetector.FindUnreportedItemsByIndexedField Method
When overridden in a derived class, returns a list of items that have the specified indexed field value and are not currently marked as active in the metadata store and that are not already marked as deleted.
Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)
Syntax
'Declaration
Public MustOverride Function FindUnreportedItemsByIndexedField ( _
fieldName As String, _
value As Object _
) As IEnumerable(Of ItemMetadata)
'Usage
Dim instance As DeleteDetector
Dim fieldName As String
Dim value As Object
Dim returnValue As IEnumerable(Of ItemMetadata)
returnValue = instance.FindUnreportedItemsByIndexedField(fieldName, _
value)
public abstract IEnumerable<ItemMetadata> FindUnreportedItemsByIndexedField(
string fieldName,
Object value
)
public:
virtual IEnumerable<ItemMetadata^>^ FindUnreportedItemsByIndexedField(
String^ fieldName,
Object^ value
) abstract
abstract FindUnreportedItemsByIndexedField :
fieldName:string *
value:Object -> IEnumerable<ItemMetadata>
public abstract function FindUnreportedItemsByIndexedField(
fieldName : String,
value : Object
) : IEnumerable<ItemMetadata>
Parameters
- fieldName
Type: System.String
The name of the indexed field.
- value
Type: System.Object
The value of the indexed field.
Return Value
Type: System.Collections.Generic.IEnumerable<ItemMetadata>
A list of items that have the specified indexed field value and are not currently marked as active in the metadata store and that are not already marked as deleted. When no items exist, an empty collection is returned.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | fieldName is a null reference (Nothing in Visual Basic) or value is a null reference (Nothing in Visual Basic). |
| ArgumentException | fieldName is 0 length, or value is a string and is 0 length. |
Remarks
An item is marked as active in the metadata store when ReplicaMetadata.SaveItemMetadata was called for a changed item, or when ReportLiveItemByIndexedField or ReportLiveItemByIndexedFields was called for an unchanged but still active item.