M

Entity.Get``1(Field, ForgeTypeId)

Description:
Retrieves the value of the field in the entity.

Remarks:

The template parameter must match the type of the field (specified when creating the Schema) exactly; this method does not perform data type conversions. The types for containers are IList for arrays and IDictionary for maps.

Overloads (4):

Get``1(Field)

Get``1(Field,ForgeTypeId)

Get``1(String)

Get``1(String,ForgeTypeId)

public FieldType Get<FieldType>(
	Field field,
	ForgeTypeId unitTypeId
)

Public Function Get(Of FieldType) ( 
	field As Field,
	unitTypeId As ForgeTypeId
) As FieldType

public:
generic<typename FieldType>
FieldType Get(
	Field^ field, 
	ForgeTypeId^ unitTypeId
)

member Get : 
        field : Field * 
        unitTypeId : ForgeTypeId -> 'FieldType

Field

field

The field to retrieve.
ForgeTypeId

unitTypeId

Identifier of the unit to which the value will be converted before returning. Must be compatible with the spec specified when creating the Schema.

Return Value FieldType FieldType

ArgumentNullException

A non-optional argument was NULL
InvalidOperationException

The Field belongs to a different Schema from this Entity, or this Entity is invalid.
ArgumentException

Requested type does not match the field type.
ArgumentException

The unitTypeId value is not compatible with the field description.
ArgumentException

This field's subschema prevents reading.

Share a snippet Help the community

Loading…

Entity.Get``1(Field, ForgeTypeId)

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments