IIterableConcept::GetDefaultIndexDimensionality method (dbgmodel.h)
Metode GetDefaultIndexDimensionality mengembalikan jumlah dimensi ke indeks default. Jika objek tidak dapat diindeks, metode ini harus mengembalikan 0 dan berhasil (S_OK). Objek apa pun yang mengembalikan nilai bukan nol dari metode ini mendeklarasikan dukungan untuk kontrak protokol yang menyatakan:
- Objek mendukung konsep yang dapat diindeks melalui dukungan IIndexableConcept
- Metode GetNext dari IModelIterator yang dikembalikan dari metode GetIterator dari konsep iterable akan mengembalikan indeks default unik untuk setiap elemen yang dihasilkan. Indeks tersebut akan memiliki jumlah dimensi seperti yang ditunjukkan di sini.
- Meneruskan indeks yang dikembalikan dari metode GetNext dari IModelIterator ke metode GetAt pada konsep yang dapat diindeks (IIndexableConcept) akan merujuk ke objek yang sama dengan yang diproduksi GetNext. Nilai yang sama dikembalikan.
Sintaks
HRESULT GetDefaultIndexDimensionality(
IModelObject *contextObject,
ULONG64 *dimensionality
);
Parameter
contextObject
Instans (penunjuk ini) sedang dikueri.
dimensionality
Jumlah dimensi pengindeks default dikembalikan di sini. Nilai pengembalian nol menunjukkan bahwa objek tidak dapat diindeks.
Menampilkan nilai
Metode ini mengembalikan HRESULT yang menunjukkan keberhasilan atau kegagalan.
Keterangan
Contoh Implementasi:
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;
}
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Header | dbgmodel.h |