IModelKeyReference interface (dbgmodel.h)
A reference to a key on a data model object.
Inheritance
IModelKeyReference inherits from IUnknown.
Methods
The IModelKeyReference interface has these methods.
| IModelKeyReference::AddRef The IModelKeyReference::AddRef method increments the reference count for an interface on an object. |
| IModelKeyReference::GetContextObject The IModelKeyReference::GetContextObject method, when called on a key reference for an object, gets the context of the object. |
| IModelKeyReference::GetKey The IModelKeyReference::GetKey method, when called on a key reference, gets the value of the underlying key and any metadata associated with the key. |
| IModelKeyReference::GetKeyName The IModelKeyReference::GetKeyName method, when called on a key reference, gets the name of the underlying key. |
| IModelKeyReference::GetKeyValue The IModelKeyReference::GetKeyValue method, when called on a key reference, gets the value of the underlying key and any metadata associated with it. |
| IModelKeyReference::GetOriginalObject The IModelKeyReference::GetOriginalObject method, when called on a key reference, gets the instance object from which the key reference was created. |
| IModelKeyReference::QueryInterface The IModelKeyReference::QueryInterface method retrieves pointers to the supported interfaces on an object. |
| IModelKeyReference::Release The IModelKeyReference::Release method decrements the reference count for an interface on an object. |
| IModelKeyReference::SetKey The IModelKeyReference::SetKey method, when called on a key reference, overwrites the object that is the value of the underlying key. |
| IModelKeyReference::SetKeyValue The IModelKeyReference::SetKeyValue method, when called on a key reference, sets the value of the object that is the value of the underlying key. |
Remarks
Key References
A key reference is, in essence, a handle to a key on a particular object. A client can retrieve such handle via methods such as GetKeyReference and use the handle later to get or set the value of the key without necessarily holding onto the original object. This type of object is an implementation of the IModelKeyReference or IModelKeyReference2 interface which is boxed into an IModelObject. The model object will return a kind of ObjectKeyReference when queried and then intrinsic value is a VT_UNKNOWN which is guaranteed to be queryable for IModelKeyReference. In process, it is guaranteed to be statically castable to IModelKeyReference.
Requirements
| Requirement | Value |
|---|---|
| Header | dbgmodel.h |