Metodo IIterableConcept::GetDefaultIndexDimensionality (dbgmodel.h)
Il metodo GetDefaultIndexDimensionality restituisce il numero di dimensioni all'indice predefinito. Se un oggetto non è indicizzato, questo metodo deve restituire 0 e avere esito positivo (S_OK). Qualsiasi oggetto che restituisce un valore diverso da zero da questo metodo dichiara il supporto per un contratto protocollo che indica:
- L'oggetto supporta il concetto indicizzatore tramite il supporto di IIndexableConcept
- Il metodo GetNext dell'IModelIterator restituito dal metodo GetIterator del concetto iterabile restituirà un indice predefinito univoco per ogni elemento prodotto. Tale indice avrà il numero di dimensioni indicate qui.
- Passando gli indici restituiti dal metodo GetNext del metodo IModelIterator al metodo GetAt nel concetto indicizzatore (IIndexableConcept) farà riferimento allo stesso oggetto prodotto da GetNext. Viene restituito lo stesso valore.
Sintassi
HRESULT GetDefaultIndexDimensionality(
IModelObject *contextObject,
ULONG64 *dimensionality
);
Parametri
contextObject
Istanza (questo puntatore) sottoposta a query.
dimensionality
Il numero di dimensioni dell'indicizzatore predefinito viene restituito qui. Un valore restituito pari a zero indica che l'oggetto non è indicizzato.
Valore restituito
Questo metodo restituisce HRESULT che indica l'esito positivo o l'errore.
Commenti
Implementazione di esempio:
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;
}
Requisiti
| Requisito | Valore |
|---|---|
| Intestazione | dbgmodel.h |