IIndexableConcept::GetDimensionality method (dbgmodel.h)

  • Article

The GetDimensionality method returns the number of dimensions that the object is indexed in. Note that if the object is both iterable and indexable, the implementation of GetDefaultIndexDimensionality must agree with the implementation of GetDimensionality as to how many dimensions the indexer has.

Syntax

HRESULT GetDimensionality(
  IModelObject *contextObject,
  ULONG64      *dimensionality
);

Parameters

contextObject

The instance object (this pointer) which is being indexed is passed here.

dimensionality

The number of dimensions that the object is indexed in is returned here.

Return value

This method returns HRESULT which indicates success or failure.

Remarks

Example Implementation:

IFACEMETHOD(GetDimensionality)(_In_ IModelObject * /*pContextObject*/, 
                               _Out_ ULONG64 *pDimensionality)
{
    // If the object is iterable, the value returned here **MUST** match 
    // what is returned from GetDefaultIndexDimensionality.
    *pDimensionality = 1;
    return S_OK;
}

Requirements

Requirement Value
Header dbgmodel.h

See also

IIndexableConcept interface