IDeviceSpecificProperty::Metode GetValue (devicetopology.h)

  • Artikel

Metode GetValue mendapatkan nilai properti khusus perangkat saat ini.

Sintaks

HRESULT GetValue(
  [out] void  *pvValue,
        DWORD *pcbValue
);

Parameter

[out] pvValue

Arahkan ke buffer yang dialokasikan pemanggil tempat metode menulis nilai properti.

pcbValue

[inout] Penunjuk ke variabel DWORD yang menentukan ukuran dalam byte nilai properti. Pada entri, *pcbValue berisi ukuran buffer yang dialokasikan penelepon (atau 0 jika pvValueadalah NULL). Sebelum mengembalikan, metode menulis ukuran aktual dari nilai properti yang ditulis ke buffer (atau ukuran yang diperlukan jika buffer terlalu kecil atau jika pvValue adalah NULL).

Mengembalikan nilai

Jika metode berhasil, metode akan mengembalikan S_OK. Jika gagal, kemungkinan kode pengembalian disertakan, tetapi tidak terbatas pada, nilai yang diperlihatkan dalam tabel berikut.

Menampilkan kode Deskripsi
E_POINTER
 Pointer pcbValue adalah NULL.
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
 Buffer yang diacu oleh parameter pvValue terlalu kecil untuk berisi nilai properti, atau pvValue adalah NULL dan ukuran nilai properti diperbaiki daripada variabel. Untuk informasi tentang makro ini, lihat dokumentasi Windows SDK.

Keterangan

Jika ukuran nilai properti bervariasi daripada tetap, pemanggil dapat memperoleh ukuran buffer yang diperlukan dengan memanggil GetValue dengan parameter pvValue = NULL dan *pcbValue = 0. Metode ini menulis ukuran buffer yang diperlukan ke *pcbValue. Dengan informasi ini, pemanggil dapat mengalokasikan buffer dengan ukuran yang diperlukan dan memanggil GetValue untuk kedua kalinya untuk mendapatkan nilai properti.

Jika buffer yang dialokasikan penelepon terlalu kecil untuk menahan nilai properti, GetValue menulis ukuran buffer yang diperlukan ke *pcbValue dan mengembalikan kode status kesalahan. Dalam hal ini, ia tidak menulis apa pun ke buffer yang ditujukkan oleh pvValue.

Persyaratan

   
Klien minimum yang didukung Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2008 [hanya aplikasi desktop]
Target Platform Windows
Header devicetopology.h

Lihat juga

Antarmuka IDeviceSpecificProperty