Método IIterableConcept::GetDefaultIndexDimensionality (dbgmodel.h)
O método GetDefaultIndexDimensionality retorna o número de dimensões para o índice padrão. Se um objeto não for indexável, esse método deverá retornar 0 e ter êxito (S_OK). Qualquer objeto que retorna um valor diferente de zero desse método está declarando suporte para um contrato de protocolo que afirma:
- O objeto dá suporte ao conceito indexável por meio do suporte de IIndexableConcept
- O método GetNext do IModelIterator retornado do método GetIterator do conceito iterável retornará um índice padrão exclusivo para cada elemento produzido. Esse índice terá o número de dimensões, conforme indicado aqui.
- Passar os índices retornados do método GetNext do IModelIterator para o método GetAt no conceito indexável (IIndexableConcept) se referirá ao mesmo objeto que GetNext produziu. O mesmo valor é retornado.
Sintaxe
HRESULT GetDefaultIndexDimensionality(
IModelObject *contextObject,
ULONG64 *dimensionality
);
Parâmetros
contextObject
A instância (esse ponteiro) que está sendo consultada.
dimensionality
O número de dimensões do indexador padrão é retornado aqui. Um valor retornado de zero indica que o objeto não é indexável.
Retornar valor
Esse método retorna HRESULT que indica êxito ou falha.
Comentários
Implementação de exemplo:
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;
}
Requisitos
Requisito | Valor |
---|---|
Cabeçalho | dbgmodel.h |