IIterableConcept::GetDefaultIndexDimensionality 方法 (dbgmodel.h)
GetDefaultIndexDimensionality 方法會將維度數目傳回預設索引。 如果對象無法編制索引,這個方法應該會傳回 0 並成功(S_OK)。 從這個方法傳回非零值的任何物件,都宣告對通訊協定合約的支援,該合約指出:
- 物件透過支援 IIndexableConcept 來支援可編製索引的概念
- IModelIterator 的 GetNext 方法 從可反覆運算概念的 GetIterator 方法傳回,將會針對每個產生的專案傳回唯一的預設索引。 這類索引的維度數目將會如這裡所示。
- 將從 IModelIterator 的 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 |