CWiauPropertyList::D efineProperty method (wiautil.h)

Metode CWiauPropertyList::D efineProperty menambahkan definisi properti ke objek daftar properti.

Sintaks

HRESULT DefineProperty(
  int      *pIdx,
  PROPID   PropId,
  LPOLESTR PropName,
  ULONG    Access,
  ULONG    SubType
);

Parameter

pIdx

Penunjuk ke lokasi memori yang menerima indeks untuk properti yang baru ditambahkan. Banyak metode lain di kelas ini menggunakan indeks properti untuk mengidentifikasi properti.

PropId

Menentukan konstanta ID properti.

PropName

Penunjuk ke string nama untuk properti .

Access

Menentukan jenis akses untuk properti, biasanya WIA_PROP_READ (baca-saja) atau WIA_PROP_RW (baca/tulis).

SubType

Menentukan subjenis properti, salah satu WIA_PROP_FLAG, WIA_PROP_LIST, WIA_PROP_RANGE, atau WIA_PROP_NONE. Tiga konstanta pertama menunjukkan, masing-masing, bahwa properti adalah sekumpulan nilai bendera, daftar nilai, atau rentang nilai. Konstanta keempat menunjukkan bahwa properti bukan salah satunya.

Nilai kembali

Metode ini mengembalikan S_OK jika berhasil menentukan properti. Jika daftar properti tidak memiliki ruang yang cukup untuk properti tambahan, metode mengembalikan E_FAIL.

Keterangan

Sebelum properti dapat ditambahkan ke daftar properti, daftar properti harus diinisialisasi. Lakukan ini dengan memanggil metode CWiauPropertyList::Init .

Persyaratan

Persyaratan Nilai
Target Platform Desktop
Header wiautil.h (termasuk Wiautil.h, Wiamindr.h)

Lihat juga

CWiauPropertyList

CWiauPropertyList::Init