IIterableConcept ::GetDefaultIndexDimensionality, méthode (dbgmodel.h)
La méthode GetDefaultIndexDimensionality retourne le nombre de dimensions à l’index par défaut. Si un objet n’est pas indexable, cette méthode doit retourner 0 et réussir (S_OK). Tout objet qui retourne une valeur non nulle de cette méthode déclare la prise en charge d’un contrat de protocole qui indique :
- L’objet prend en charge le concept indexable via la prise en charge de IIndexableConcept
- La méthode GetNext de l'IModelIterator retournée par la méthode GetIterator du concept itérable retourne un index par défaut unique pour chaque élément produit. Ce type d’index aura le nombre de dimensions indiquées ici.
- Le passage des index retournés par la méthode GetNext de l'IModelIterator à la méthode GetAt sur le concept indexable (IIndexableConcept) fait référence au même objet que GetNext produit. La même valeur est retournée.
Syntaxe
HRESULT GetDefaultIndexDimensionality(
IModelObject *contextObject,
ULONG64 *dimensionality
);
Paramètres
contextObject
Instance (ce pointeur) interrogée.
dimensionality
Le nombre de dimensions de l’indexeur par défaut est retourné ici. Une valeur de retour de zéro indique que l’objet n’est pas indexable.
Valeur de retour
Cette méthode retourne HRESULT qui indique la réussite ou l’échec.
Remarques
exemple d’implémentation :
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;
}
Exigences
| Exigence | Valeur |
|---|---|
| d’en-tête | dbgmodel.h |