ItemMetadata.GetStringField 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 GetStringField ( _
fieldName As String _
) As String
'Usage
Dim instance As ItemMetadata
Dim fieldName As String
Dim returnValue As String
returnValue = instance.GetStringField(fieldName)
public abstract string GetStringField(
string fieldName
)
public:
virtual String^ GetStringField(
String^ fieldName
) abstract
abstract GetStringField :
fieldName:string -> string
public abstract function GetStringField(
fieldName : String
) : String
Parameters
- fieldName
Type: System.String
The name of the custom field.
Return Value
Type: System.String
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 | 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.