FieldSchema Class

Contains schema information that defines a custom field of an item in the metadata store.

Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in microsoft.synchronization.metadatastorage.dll)

public class FieldSchema
public class FieldSchema
public class FieldSchema

A set of custom fields can be defined for item metadata. Each field consists of a unique string name and a value. These fields can be used to store any additional metadata about an item that is not otherwise supported by the default set of item metadata. The fields can be accessed through various methods on ItemMetadata, such as GetByteField or SetCustomField. These fields and their format, including size and data type, are defined when the metadata store is initialized for a replica by using MetadataStore.InitializeReplicaMetadata.

The schema contains the length for the field value. For fixed-length fields, this value is the size of the data type in bytes. For variable-length fields, this value specifies the maximum length of the field in bytes.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.