Element.GetEntity
Method
Description:
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
Remarks:
The Entity that is returned is a copy of the stored data (with copy-on-write optimization). Modifying it is allowed (even with restricted write), but to save your changes you must call SetEntity.
The Entity that is returned is a copy of the stored data (with copy-on-write optimization). Modifying it is allowed (even with restricted write), but to save your changes you must call SetEntity.
Parameters
Parameter | Type | Description |
---|---|---|
schema | Schema | The Schema describing the Entity. |
Return Value
Type | Description |
---|---|
Entity | The returned Entity. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | Reading of Entities of this Schema is not allowed to the current add-in. |
ArgumentNullException | A non-optional argument was null |