Edit

IModelObject::EnumerateKeys method (dbgmodel.h)

  • Article

Enumerates the keys within the dynamic key provider. The returned enumerator must behave as per an EnumerateKeys(...) call on IModelObject and not as EnumerateKeyValues or any of the other enumeration variants.

Note that from the perspective of a single dynamic key provider, it is illegal to enumerate multiple keys of the same name that are physically distinct keys.

Syntax

HRESULT EnumerateKeys(
  IKeyEnumerator **enumerator
);

Parameters

enumerator

An enumerator for all keys on the object (and all of its parent models) and their values and metadata is returned in this argument as an IKeyEnumerator.

Return value

This method returns HRESULT that indicates success or failure.

Remarks

The EnumerateKeys method behaves similar to the EnumerateKeyValues method excepting that it does not automatically resolve property accessors on the object. This means that if the value of a key is a property accessor, the EnumerateKeys method will return the property accessor (an IModelPropertyAccessorInterface) boxed into an IModelObject rather than automatically calling the GetValue method. This is similar to the difference between GetKey and GetKeyValue.

Requirements

Requirement Value
Header dbgmodel.h

See also

IModelObject interface