IIterableConcept::GetDefaultIndexDimensionality-Methode (dbgmodel.h)
Die GetDefaultIndexDimensionality-Methode gibt die Anzahl der Dimensionen an den Standardindex zurück. Wenn ein Objekt nicht indiziert werden kann, sollte diese Methode 0 zurückgeben und erfolgreich (S_OK). Jedes Objekt, das einen Wert ungleich Null aus dieser Methode zurückgibt, deklariert die Unterstützung für einen Protokollvertrag, der folgendes angibt:
- Das Objekt unterstützt das indizierbare Konzept durch Unterstützung von IIndexableConcept-
- Die GetNext-Methode der IModelIterator von der GetIterator-Methode des iterablen Konzepts zurückgegeben wird, gibt einen eindeutigen Standardindex für jedes produzierte Element zurück. Dieser Index hat die Anzahl der Dimensionen, wie hier angegeben.
- Durch Übergeben der von der GetNext-Methode des IModelIterator an die GetAt-Methode für das indizierbare Konzept (IIndexableConcept) zurückgegebenen Indizes wird auf dasselbe Objekt verwiesen, das GetNext produziert hat. Derselbe Wert wird zurückgegeben.
Syntax
HRESULT GetDefaultIndexDimensionality(
IModelObject *contextObject,
ULONG64 *dimensionality
);
Parameter
contextObject
Die Instanz (dieser Zeiger), die abgefragt wird.
dimensionality
Die Anzahl der Dimensionen des Standardindexers wird hier zurückgegeben. Ein Rückgabewert von Null gibt an, dass das Objekt nicht indiziert werden kann.
Rückgabewert
Diese Methode gibt HRESULT zurück, das Erfolg oder Fehler angibt.
Bemerkungen
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 |