ReplicaMetadata::FindItemMetadataByIndexedField Method

When overridden in a derived class, returns a list of item metadata entries that have the specified value for the indexed field.

Namespace:  Microsoft.Synchronization.MetadataStorage
Assembly:  Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

public:
virtual IEnumerable<ItemMetadata^>^ FindItemMetadataByIndexedField(
	String^ fieldName, 
	Object^ fieldValue
) abstract

Parameters

fieldName
Type: System::String
The name of the indexed field. The field must be a valid field and an index field.
fieldValue
Type: System::Object
The value of the indexed field.

Return Value

Type: System.Collections.Generic::IEnumerable<ItemMetadata>
A list of item metadata entries that have the specified value for the indexed field. An empty collection is returned when no items exist.

ExceptionCondition
ObjectDisposedException

The object has been disposed or was not initialized correctly.

ArgumentNullException

fieldName or fieldValue is a nullptr.

ArgumentException

fieldName is 0 length, or fieldValue is both a string type and 0 length.

NotSupportedException

fieldValue is of an unsupported type.

MetadataFieldNotFoundException

fieldName was not found or is not valid.

Custom fields must be established when the replica metadata is first initialized by passing FieldSchema to InitializeReplicaMetadata.

Index fields must be established when the replica metadata is first initialized by passing IndexSchema to InitializeReplicaMetadata.

Show: