FieldSchema Class
Contains schema information that defines a custom field of an item in the metadata store.
Inheritance Hierarchy
System.Object
Microsoft.Synchronization.MetadataStorage.FieldSchema
Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)
Syntax
'Declaration
Public Class FieldSchema
'Usage
Dim instance As FieldSchema
public class FieldSchema
public ref class FieldSchema
type FieldSchema = class end
public class FieldSchema
The FieldSchema type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
FieldSchema(String, Type) | Initializes a new instance of the FieldSchema class that is based on the specified name and data type. |
|
FieldSchema(String, Type, UInt32) | Initializes a new instance of the FieldSchema class that is based on the specified name, data type, and the maximum length of the field. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
DataType | Gets the data type of the field. |
|
MaxLength | Gets the maximum length of the field. |
|
Name | Gets the name of the custom field. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top
Remarks
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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.