Share via


ItemMetadata.GetByteField Method

When overridden in a derived class, gets the value of the specified custom field.

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

Syntax

'Declaration
Public MustOverride Function GetByteField ( _
    fieldName As String _
) As Nullable(Of Byte)
'Usage
Dim instance As ItemMetadata
Dim fieldName As String
Dim returnValue As Nullable(Of Byte)

returnValue = instance.GetByteField(fieldName)
public abstract Nullable<byte> GetByteField (
    string fieldName
)
public:
virtual Nullable<unsigned char> GetByteField (
    String^ fieldName
) abstract
public abstract Nullable<byte> GetByteField (
    String fieldName
)
public abstract function GetByteField (
    fieldName : String
) : Nullable<byte>

Parameters

  • fieldName
    The name of the custom field.

Return Value

The value of the specified custom field. Returns a null reference (Nothing in Visual Basic) when the field value has not been set.

Exceptions

Exception type Condition

ArgumentNullException

fieldName is a null reference (Nothing in Visual Basic).

ArgumentException

fieldName is 0 length.

Remarks

Custom fields must be defined in a FieldSchema object when the replica metadata is first initialized.

See Also

Reference

ItemMetadata Class
ItemMetadata Members
Microsoft.Synchronization.MetadataStorage Namespace