IModelKeyReference2 interface (dbgmodel.h)
A reference to a key on a data model object.
This version 2 of the interface supports all of the previous methods with identical signatures and includes additional new methods that provide added functionality. The new methods are listed in the header at the end of the section for that interface.
Inheritance
IModelKeyReference2 inherits from IModelKeyReference.
Methods
The IModelKeyReference2 interface has these methods.
| IModelKeyReference2::AddRef The IModelKeyReference2::AddRef method increments the reference count for an interface on an object. |
| IModelKeyReference2::GetContextObject The IModelKeyReference2::GetContextObject method, when called on a key reference for an object, gets the context of the object. |
| IModelKeyReference2::GetKey The IModelKeyReference2::GetKey method, when called on a key reference, gets the value of the underlying key and any metadata associated with the key. |
| IModelKeyReference2::GetKeyName The IModelKeyReference2::GetKeyName method, when called on a key reference, gets the name of the underlying key. |
| IModelKeyReference2::GetKeyValue The IModelKeyReference2::GetKeyValue method, when called on a key reference, gets the value of the underlying key and any metadata associated it. |
| IModelKeyReference2::GetOriginalObject The IModelKeyReference2::GetOriginalObject method, when called on a key reference, gets the instance object from which the key reference was created. |
| IModelKeyReference2::OverrideContextObject The OverrideContextObject method is an method which is used to permanently alter the context object which this key reference will pass to any underlying property accessor's GetValue or SetValue methods. |
| IModelKeyReference2::QueryInterface The IModelKeyReference2::QueryInterface method retrieves pointers to the supported interfaces on an object. |
| IModelKeyReference2::Release The IModelKeyReference2::Release method decrements the reference count for an interface on an object. |
| IModelKeyReference2::SetKey The IModelKeyReference2::SetKey method, when called on a key reference, overwrites the object that is the value of the underlying key. |
| IModelKeyReference2::SetKeyValue The IModelKeyReference2::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 |