Méthode IIterableConcept ::GetDefaultIndexDimensionality (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 autre que zéro à partir 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. Un tel index aura le nombre de dimensions indiqué ici.
• La transmission 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

Le instance (ce pointeur) interrogé.

dimensionality

Le nombre de dimensions de l’indexeur par défaut est retourné ici. Une valeur de retour égale à zéro indique que l’objet n’est pas indexable.

Valeur retournée

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

Configuration requise

Condition requise	Valeur
En-tête	dbgmodel.h

Voir aussi

Interface IIterableConcept