IIterableConcept::GetDefaultIndexDimensionality-Methode (dbgmodel.h)

Die GetDefaultIndexDimensionality-Methode gibt die Anzahl der Dimensionen auf den Standardindex zurück. Wenn ein Objekt nicht indiziert werden kann, sollte diese Methode 0 zurückgeben und erfolgreich sein (S_OK). Jedes Objekt, das einen Ungleich nullwert dieser Methode zurückgibt, deklariert die Unterstützung für einen Protokollvertrag, der Folgendes angibt:

• Das Objekt unterstützt das indizierbare Konzept über die Unterstützung von IIndexableConcept.
• Die GetNext-Methode des IModelIterators , die von der GetIterator-Methode des iterierbaren Konzepts zurückgegeben wird, gibt einen eindeutigen Standardindex für jedes produzierte Element zurück. Ein solcher Index weist die hier angegebene Anzahl von Dimensionen auf.
• Das Übergeben der von der GetNext-Methode des IModelIterator zurückgegebenen Indizes an die GetAt-Methode für das indexierbare Konzept (IIndexableConcept) verweist auf dasselbe Objekt, das GetNext erstellt hat. Der gleiche Wert wird zurückgegeben.

Syntax

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

Parameter

contextObject

Der instance (dieser Zeiger), der abgefragt wird.

dimensionality

Die Anzahl der Dimensionen des Standardindexers wird hier zurückgegeben. Ein Rückgabewert von 0 gibt an, dass das Objekt nicht indiziert werden kann.

Rückgabewert

Diese Methode gibt HRESULT zurück, was auf Erfolg oder Fehler hinweist.

Hinweise

Beispielimplementierung:

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;
}

Anforderungen

Anforderung	Wert
Header	dbgmodel.h

Weitere Informationen

IIterableConcept-Schnittstelle