IUserData Interface
GetData
SetData
GetLayerName
SetLayerName
IUserData interface gives access to two user-defined properties in items:
"Object User Data" and "Layer Name"
IUserData can be queried fro the correspondent ISection
or IItem
interface.
See also User Data Sample, IDataTable,
IData, IRecordSet
HRESULT
GetData(int *data)
Parameters
data - [out, retval] The returned
number associated with the object
Return Values:
- S_OK in case of
success.
Remarks:
Returns the integer number stored by a call to SetData below or
default. The default value for objects in the model is 0.
HRESULT
SetData(int data)
Parameters
data - [in] the number stored in the
object, which implements the interface.
Return Values
- S_OK in case of
success.
Remarks:
Stores the integer number in a member of the object, which implements the
interface. The default value for objects in the model is 0. The number can serve
as an index or link to expanded information about the object.
HRESULT GetLayerName(BSTR *name)
Parameters
name
- [out, retval] Name of the layer where the object
belongs to.
Return Values
- S_OK in case of
success.
Remarks:
Returns layer name to the object. There is no separate "layer"
objects created in DG Kernel models. In every operations where layers are involved
only the assigned names are used to to dynamically classify objects.
HRESULT SetLayerName(char* name)
Parameters
name
- [in] Name of the table to be created. Ignored in
this release. Can be set to empty string or NULL.
Return Values
- S_OK in case of
success.
Remarks:
Assigns layer name to the object. There is no separate "layer"
objects created in DG Kernel models. In every operations where layer is involved
only the assigned names are used to to dynamically classify objects.
|