Fungsi SetupDiGetDeviceInterfacePropertyW (setupapi.h)

Fungsi SetupDiGetDeviceInterfaceProperty mengambil properti perangkat yang diatur untuk antarmuka perangkat.

Sintaks

WINSETUPAPI BOOL SetupDiGetDeviceInterfacePropertyW(
  [in]            HDEVINFO                  DeviceInfoSet,
  [in]            PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData,
  [in]            const DEVPROPKEY          *PropertyKey,
  [out]           DEVPROPTYPE               *PropertyType,
  [out]           PBYTE                     PropertyBuffer,
  [in]            DWORD                     PropertyBufferSize,
  [out, optional] PDWORD                    RequiredSize,
  [in]            DWORD                     Flags
);

Parameter

[in] DeviceInfoSet

Handel ke set informasi perangkat yang berisi antarmuka perangkat untuk mengambil properti antarmuka perangkat.

[in] DeviceInterfaceData

Penunjuk ke struktur SP_DEVICE_INTERFACE_DATA yang mewakili antarmuka perangkat untuk mengambil properti antarmuka perangkat.

[in] PropertyKey

Penunjuk ke struktur DEVPROPKEY yang mewakili kunci properti antarmuka perangkat dari properti antarmuka perangkat untuk diambil.

[out] PropertyType

Penunjuk ke variabel berjenis DEVPROPTYPE yang menerima pengidentifikasi tipe data properti dari properti antarmuka perangkat yang diminta. Pengidentifikasi tipe data properti adalah bitwise ATAU antara pengidentifikasi tipe data dasar dan, jika jenis data dasar dimodifikasi, pengubah tipe data properti.

[out] PropertyBuffer

Penunjuk ke buffer yang menerima properti antarmuka perangkat yang diminta. SetupDiGetDeviceInterfaceProperty mengambil properti yang diminta hanya jika buffer cukup besar untuk menyimpan semua data nilai properti. Penunjuk bisa NULL. Jika pointer diatur ke NULL dan RequiredSize disediakan, SetupDiGetDeviceInterfaceProperty mengembalikan ukuran properti, dalam byte, di *RequiredSize.

[in] PropertyBufferSize

Ukuran, dalam byte, dari buffer PropertyBuffer . Jika PropertyBuffer diatur ke NULL, PropertyBufferSize harus diatur ke nol.

[out, optional] RequiredSize

Penunjuk ke variabel berjenis DWORD yang menerima ukuran, dalam byte, dari properti antarmuka perangkat jika properti diambil atau ukuran buffer yang diperlukan, jika buffer tidak cukup besar. Penunjuk ini dapat diatur ke NULL.

[in] Flags

Parameter ini harus diatur ke nol.

Nilai kembali

SetupDiGetDeviceInterfaceProperty mengembalikan TRUE jika berhasil. Jika tidak, kesalahan mengembalikan FALSE, dan kesalahan yang dicatat dapat diambil dengan memanggil GetLastError.

Tabel berikut ini menyertakan beberapa kode kesalahan yang lebih umum yang mungkin dicatat fungsi ini. Kode kesalahan lainnya dapat diatur oleh fungsi alat penginstal perangkat yang dipanggil oleh API ini.

Menampilkan kode	Deskripsi
ERROR_INVALID_FLAGS	Nilai Bendera bukan nol.
ERROR_INVALID_HANDLE	Kumpulan informasi perangkat yang ditentukan oleh DevInfoSet tidak valid.
ERROR_INVALID_PARAMETER	Parameter yang disediakan tidak valid. Salah satu kemungkinannya adalah antarmuka perangkat yang ditentukan oleh DeviceInterfaceData tidak valid.
ERROR_INVALID_REG_PROPERTY	Kunci properti yang disediakan oleh PropertyKey tidak valid.
ERROR_INVALID_DATA	Nilai data internal yang tidak ditentukan tidak valid.
ERROR_INVALID_USER_BUFFER	Buffer pengguna tidak valid. Salah satu kemungkinannya adalah propertyBuffer adalah NULL, dan PropertyBufferSize bukan nol.
ERROR_NO_SUCH_DEVICE_INTERFACE	Antarmuka perangkat yang ditentukan oleh DeviceInterfaceData tidak ada.
ERROR_INSUFFICIENT_BUFFER	Buffer PropertyBuffer tidak cukup besar untuk menahan nilai properti, atau buffer data internal yang diteruskan ke panggilan sistem terlalu kecil.
ERROR_NOT_ENOUGH_MEMORY	Tidak tersedia cukup memori sistem untuk menyelesaikan operasi.
ERROR_NOT_FOUND	Properti perangkat yang diminta tidak ada.
ERROR_ACCESS_DENIED	Pemanggil tidak memiliki hak istimewa Administrator.

Keterangan

SetupDiGetDeviceInterfaceProperty adalah bagian dari model properti perangkat terpadu.

SetupAPI hanya mendukung versi Unicode setupDiGetDeviceInterfaceProperty.

Penelepon SetupDiGetDeviceInterfaceProperty harus menjadi anggota grup Administrator untuk mengatur properti antarmuka perangkat.

Untuk mendapatkan kunci properti perangkat yang mewakili properti perangkat yang diatur untuk antarmuka perangkat, panggil SetupDiGetDeviceInterfacePropertyKeys.

Untuk mengatur properti antarmuka perangkat, panggil SetupDiSetDeviceInterfaceProperty.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows Vista dan versi Windows yang lebih baru.
Target Platform	DesktopUntuk universal, panggil CM_Get_Device_Interface_Property
Header	setupapi.h (termasuk Setupapi.h)
Pustaka	Setupapi.lib

Lihat juga

SetupDiGetDeviceInterfacePropertyKeys

SetupDiSetDeviceInterfaceProperty