Interface supported by model entities - things that are in the database.
More...
List of all members.
Properties |
BOOL | IsVirtual [get] |
| [propget] Returns true iff the entity is a virtual entity - not really in the model.
|
long | Id [get] |
| [propget] Get the id of this entity.
|
BSTR | TypeName [get] |
| [propget] Returns the user-friendly type name of this object. This name is not localized.
|
Detailed Description
Interface supported by model entities - things that are in the database.
Property Documentation
long ISkpEntity::Id [get] |
[propget] Get the id of this entity.
Ids are assigned at runtime, are unique within a model for that given runtime execution of the model. These are not persisted in the database, and can only be used within the session in which they were determined.
- Return values:
-
| pVal | The Id of the entity. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpEntity::IsVirtual [get] |
[propget] Returns true iff the entity is a virtual entity - not really in the model.
There are certain entities that are generated at runtime, only for the purposes of the API. These entities are designated as "virtual". The vast majority of entities are not virtual.
- See also:
- ISkpLineCurve
- Parameters:
-
| pVal | TRUE iff this entity is virtual. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BSTR ISkpEntity::TypeName [get] |
[propget] Returns the user-friendly type name of this object. This name is not localized.
- Parameters:
-
| pVal | The typename for this object. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.