Metode IDynamicKeyProviderConcept::GetKey (dbgmodel.h)

Metode GetKey pada penyedia kunci dinamis sebagian besar merupakan penimpaan metode GetKey pada IModelObject. Penyedia kunci dinamis diharapkan untuk mengembalikan nilai kunci dan metadata apa pun yang terkait dengan kunci tersebut. Jika kunci tidak ada (tetapi tidak ada kesalahan lain yang terjadi), penyedia harus mengembalikan false dalam parameter hasKey dan berhasil dengan S_OK. Gagal dalam panggilan ini dianggap sebagai kegagalan untuk mengambil kunci dan akan secara eksplisit menghentikan pencarian kunci melalui rantai model induk. Mengembalikan false di hasKey dan keberhasilan akan melanjutkan pencarian kunci.

Perhatikan bahwa sangat legal bagi GetKey untuk mengembalikan pengakses properti kotak sebagai kunci. Ini akan secara semantik identik dengan metode GetKey pada IModelObject yang mengembalikan pengakses properti.

Sintaks

HRESULT GetKey(
  IModelObject *contextObject,
  PCWSTR       key,
  IModelObject **keyValue,
  IKeyStore    **metadata,
  bool         *hasKey
);

Parameter

contextObject

Objek instans (penunjuk ini) untuk mendapatkan kunci.

key

Nama kunci yang diambil.

keyValue

Nilai kunci seperti yang ditentukan oleh penyedia dinamis dikembalikan di sini. Jika terjadi kesalahan dalam pengambilan dan HRESULT yang tidak valid dikembalikan, ini dapat mengembalikan informasi kesalahan yang diperluas. Ini legal untuk implementasi metode GetKey untuk mengembalikan pengakses properti (IModelPropertyAccessor).

metadata

Metadata apa pun yang terkait dengan kunci secara opsional dapat dikembalikan di sini.

hasKey

Indikasi apakah penyedia dinamis memiliki kunci atau tidak. Jika penyedia tidak memiliki kunci, penyedia harus mengembalikan false di sini dan berhasil.

Mengembalikan nilai

Metode ini mengembalikan HRESULT yang menunjukkan keberhasilan atau kegagalan.

Persyaratan

   
Header dbgmodel.h

Lihat juga

Antarmuka IDynamicKeyProviderConcept