ReplicaMetadata.FindItemMetadataByUniqueIndexedField Method

When overridden in a derived class, returns the unique item metadata entry that has the specified value for the indexed field.

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

public abstract ItemMetadata FindItemMetadataByUniqueIndexedField(
	string fieldName,
	Object fieldValue
)

Parameters

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

Return Value

Type: Microsoft.Synchronization.MetadataStorage.ItemMetadata
The unique metadata entry that has the specified value for the indexed field. A null is returned when no item exists.

ExceptionCondition
ObjectDisposedException

The object has been disposed or was not initialized correctly.

ArgumentNullException

fieldName or fieldValue is a null.

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.

MetadataStoreInvalidOperationException

The specified field is not a unique index.

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

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

Show: