Visual Basic (Declaration) | |
---|---|
Public Sub RemoveEntity( _ ByVal entity As Object, _ Optional ByVal clearQueryCache As Nullable(Of Boolean) _ ) |
Visual Basic (Usage) | ![]() |
---|---|
Dim instance As EntityManager Dim entity As Object Dim clearQueryCache As Nullable(Of Boolean) instance.RemoveEntity(entity, clearQueryCache) |
C# | |
---|---|
public void RemoveEntity( object entity, Nullable<bool> clearQueryCache ) |
C++/CLI | |
---|---|
public: void RemoveEntity( Object^ entity, Nullable<bool> clearQueryCache ) |
Parameters
- entity
- The Entity to be removed
- clearQueryCache
- Whether removing this entity should also cause the QueryCache to be cleared. The default 'null' value allows DevForce to make this determination based on the entity being removed.
The IEntity will be in a "detached" state after the remove. RemoveEntity and EntityAspect.RemoveFromManager can be used interchangeably
The query cache should normally be cleared after removing an entity from the entity cache, since removing an entity can invalidate the usefulness of the query cache and lead to incorrect query results. You can choose not to clear the query cache if you know that removing the entity will not cause problems.
This does not delete the object from the backend data source. To delete an entity, use the IdeaBlade.EntityModel.Entity.Delete() method.
Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family