IIterableConcept::GetDefaultIndexDimensionality メソッド (dbgmodel.h)

GetDefaultIndexDimensionality メソッドは、ディメンションの数を既定のインデックスに返します。 オブジェクトがインデックスを作成できない場合、このメソッドは 0 を返し、成功する必要があります (S_OK)。 このメソッドから 0 以外の値を返すオブジェクトは、次の状態のプロトコル コントラクトのサポートを宣言しています。

• このオブジェクトは、IIndexableConcept サポートすることにより、インデックス可能な概念をサポートします
• iterable 概念の GetIterator メソッドから返される IModelIterator の GetNext メソッドは、生成された各要素の一意の既定のインデックスを返します。 このようなインデックスには、次に示すようにディメンションの数が含まれます。
• IModelIterator の GetNext メソッドから返されたインデックスを、インデックス可能な概念 (IIndexableConcept) の GetAt メソッドに渡すと、GetNext が生成したのと同じオブジェクトが参照されます。 同じ値が返されます。

構文

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

パラメーター

contextObject

クエリ対象のインスタンス (このポインター)。

dimensionality

ここでは、既定のインデクサーのディメンションの数が返されます。 戻り値が 0 の場合、オブジェクトはインデックスを作成できません。

戻り値

このメソッドは、成功または失敗を示す 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 インターフェイス の