IIterableConcept::GetDefaultIndexDimensionality 方法 (dbgmodel.h)

GetDefaultIndexDimensionality 方法将维度数返回到默认索引。 如果对象不可编制索引,此方法应返回 0 并成功(S_OK)。 从此方法返回非零值的任何对象都声明对协议协定的支持,该协定指出:

  • 该对象通过支持 IIndexableConcept 来支持可索引的概念
  • IModelIterator 从可迭代概念的 GetIterator 方法返回的 GetNext 方法将为每个生成的元素返回唯一的默认索引。 此类索引将具有此处所示的维度数。
  • 将从 IModelIter ator 的 GetNext 方法返回的索引传递给可索引概念上的 GetAt 方法(IIndexableConcept)将引用 GetNext 生成的同一对象。 返回相同的值。

语法

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

参数

contextObject

正在查询的实例(此指针)。

dimensionality

此处返回默认索引器的维度数。 返回值为零表示对象不可编制索引。

返回值

此方法返回 HRESULT,指示成功或失败。

言论

示例实现:

IFACEMETHOD(GetDefaultIndexDimensionality)(_In_ IModelObject * /*pContextObject*/,
                                           _Out_ ULONG64 *pDimensionality)
{
    // If the object is not indexable, pDimensionality should be 0 and the 
    // method should return S_OK.  Here, the object is indexable in one dimension.
    // Providing this information requires that our iterator return these 
    // 1D indexes and that we have an indexer which accepts them.
    *pDimensionality = 1;
    return S_OK;
}

要求

要求 价值
标头 dbgmodel.h

另请参阅

IIterableConcept 接口