Fungsi SetupDiGetDeviceRegistryPropertyW (setupapi.h)
Fungsi SetupDiGetDeviceRegistryProperty mengambil properti perangkat Plug and Play tertentu.
Sintaks
WINSETUPAPI BOOL SetupDiGetDeviceRegistryPropertyW(
[in] HDEVINFO DeviceInfoSet,
[in] PSP_DEVINFO_DATA DeviceInfoData,
[in] DWORD Property,
[out, optional] PDWORD PropertyRegDataType,
[out, optional] PBYTE PropertyBuffer,
[in] DWORD PropertyBufferSize,
[out, optional] PDWORD RequiredSize
);
Parameter
[in] DeviceInfoSet
Handel ke kumpulan informasi perangkat yang berisi elemen informasi perangkat yang mewakili perangkat untuk mengambil properti Plug and Play.
[in] DeviceInfoData
Penunjuk ke struktur SP_DEVINFO_DATA yang menentukan elemen informasi perangkat di DeviceInfoSet.
[in] Property
Salah satu nilai berikut yang menentukan properti yang akan diambil:
SPDRP_ADDRESS
Fungsi ini mengambil alamat perangkat.
SPDRP_BUSNUMBER
Fungsi ini mengambil nomor bus perangkat.
SPDRP_BUSTYPEGUID
Fungsi ini mengambil GUID untuk jenis bus perangkat.
SPDRP_CAPABILITIES
Fungsi ini mengambil bitwise OR dari bendera CM_DEVCAP_Xxx berikut dalam DWORD. Kemampuan perangkat yang diwakili oleh bendera ini sesuai dengan kemampuan perangkat yang diwakili oleh anggota struktur DEVICE_CAPABILITIES . Konstanta CM_DEVCAP_Xxx ditentukan dalam Cfgmgr32.h.
bendera CM_DEVCAP_Xxx | Anggota struktur DEVICE_CAPABILITIES terkait |
---|---|
CM_DEVCAP_LOCKSUPPORTED | LockSupported |
CM_DEVCAP_EJECTSUPPORTED | EjectSupported |
CM_DEVCAP_REMOVABLE | Removable |
CM_DEVCAP_DOCKDEVICE | DockDevice |
CM_DEVCAP_UNIQUEID | UniqueID |
CM_DEVCAP_SILENTINSTALL | SilentInstall |
CM_DEVCAP_RAWDEVICEOK | RawDeviceOK |
CM_DEVCAP_SURPRISEREMOVALOK | SurpriseRemovalOK |
CM_DEVCAP_HARDWAREDISABLED | HardwareDisabled |
CM_DEVCAP_NONDYNAMIC | NonDynamic |
SPDRP_CHARACTERISTICS
Fungsi ini mengambil bitwise OR dari bendera karakteristik perangkat dalam DWORD. Untuk deskripsi bendera ini, yang didefinisikan dalam Wdm.h dan Ntddk.h, lihat parameter DeviceCharacteristics dari fungsi IoCreateDevice .
SPDRP_CLASS
Fungsi ini mengambil string REG_SZ yang berisi kelas penyiapan perangkat perangkat.
SPDRP_CLASSGUID
Fungsi ini mengambil string REG_SZ yang berisi GUID yang mewakili kelas penyiapan perangkat perangkat.
SPDRP_COMPATIBLEIDS
Fungsi ini mengambil string REG_MULTI_SZ yang berisi daftar ID yang kompatibel untuk perangkat. Untuk informasi tentang ID yang kompatibel, lihat String Identifikasi Perangkat.
SPDRP_CONFIGFLAGS
Fungsi ini mengambil bitwise OR dari bendera konfigurasi perangkat dalam nilai DWORD. Bendera konfigurasi diwakili oleh bitmask CONFIGFLAG_Xxx yang ditentukan dalam Regstr.h.
SPDRP_DEVICE_POWER_DATA
(Windows XP dan yang lebih baru) Fungsi ini mengambil struktur CM_POWER_DATA yang berisi informasi manajemen daya perangkat.
SPDRP_DEVICEDESC
Fungsi ini mengambil string REG_SZ yang berisi deskripsi perangkat.
SPDRP_DEVTYPE
Fungsi ini mengambil nilai DWORD yang mewakili jenis perangkat. Untuk informasi selengkapnya, lihat Menentukan Jenis Perangkat.
SPDRP_DRIVER
Fungsi ini mengambil string yang mengidentifikasi kunci perangkat lunak perangkat (terkadang disebut kunci driver). Untuk informasi selengkapnya tentang kunci driver, lihat Pohon registri dan Kunci untuk Perangkat dan Driver.
SPDRP_ENUMERATOR_NAME
Fungsi ini mengambil string REG_SZ yang berisi nama enumerator perangkat.
SPDRP_EXCLUSIVE
Fungsi ini mengambil nilai DWORD yang menunjukkan apakah pengguna dapat memperoleh penggunaan perangkat secara eksklusif. Nilai yang dikembalikan adalah satu jika penggunaan eksklusif diizinkan, atau nol sebaliknya. Untuk informasi selengkapnya, lihat IoCreateDevice.
SPDRP_FRIENDLYNAME
Fungsi ini mengambil string REG_SZ yang berisi nama perangkat yang mudah diingat.
SPDRP_HARDWAREID
Fungsi ini mengambil string REG_MULTI_SZ yang berisi daftar ID perangkat keras untuk perangkat. Untuk informasi tentang ID perangkat keras, lihat String Identifikasi Perangkat.
SPDRP_INSTALL_STATE
(Windows XP dan yang lebih baru) Fungsi ini mengambil nilai DWORD yang menunjukkan status penginstalan perangkat. Status penginstalan diwakili oleh salah satu nilai CM_INSTALL_STATE_Xxx yang ditentukan dalam Cfgmgr32.h. Nilai CM_INSTALL_STATE_Xxx sesuai dengan nilai enumerasi DEVICE_INSTALL_STATE .
SPDRP_LEGACYBUSTYPE
Fungsi ini mengambil jenis bus warisan perangkat sebagai nilai INTERFACE_TYPE (didefinisikan dalam Wdm.h dan Ntddk.h).
SPDRP_LOCATION_INFORMATION
Fungsi ini mengambil string REG_SZ yang berisi lokasi perangkat keras perangkat.
SPDRP_LOCATION_PATHS
(Windows Server 2003 dan yang lebih baru) Fungsi ini mengambil string REG_MULTI_SZ yang mewakili lokasi perangkat di pohon perangkat.
SPDRP_LOWERFILTERS
Fungsi ini mengambil string REG_MULTI_SZ yang berisi nama driver filter bawah perangkat.
SPDRP_MFG
Fungsi ini mengambil string REG_SZ yang berisi nama produsen perangkat.
SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
Fungsi ini mengambil string REG_SZ yang berisi nama yang terkait dengan PDO perangkat. Untuk informasi selengkapnya, lihat IoCreateDevice.
SPDRP_REMOVAL_POLICY
(Windows XP dan yang lebih baru) Fungsi ini mengambil kebijakan penghapusan perangkat saat ini sebagai DWORD yang berisi salah satu nilai CM_REMOVAL_POLICY_Xxx yang ditentukan dalam Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_HW_DEFAULT
(Windows XP dan yang lebih baru) Fungsi ini mengambil kebijakan penghapusan default yang ditentukan perangkat keras perangkat sebagai DWORD yang berisi salah satu nilai CM_REMOVAL_POLICY_Xxx yang ditentukan dalam Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_OVERRIDE
(Windows XP dan yang lebih baru) Fungsi ini mengambil kebijakan penghapusan penggantian perangkat (jika ada) dari registri, sebagai DWORD yang berisi salah satu nilai CM_REMOVAL_POLICY_Xxx yang ditentukan dalam Cfgmgr32.h.
SPDRP_SECURITY
Fungsi ini mengambil struktur SECURITY_DESCRIPTOR untuk perangkat.
SPDRP_SECURITY_SDS
Fungsi ini mengambil string REG_SZ yang berisi deskriptor keamanan perangkat. Untuk informasi tentang string deskriptor keamanan, lihat Bahasa Definisi Deskriptor Keamanan (Windows). Untuk informasi tentang format string deskriptor keamanan, lihat Bahasa Definisi Deskriptor Keamanan (Windows).
SPDRP_SERVICE
Fungsi ini mengambil string REG_SZ yang berisi nama layanan untuk perangkat.
SPDRP_UI_NUMBER
Fungsi ini mengambil nilai DWORD yang diatur ke nilai anggota UINumber dari struktur DEVICE_CAPABILITIES perangkat.
SPDRP_UI_NUMBER_DESC_FORMAT
Fungsi ini mengambil string format (REG_SZ) yang digunakan untuk menampilkan nilai UINumber .
SPDRP_UPPERFILTERS
Fungsi ini mengambil string REG_MULTI_SZ yang berisi nama driver filter atas perangkat.
[out, optional] PropertyRegDataType
Penunjuk ke variabel yang menerima jenis data properti yang sedang diambil. Ini adalah salah satu jenis data registri standar. Parameter ini bersifat opsional dan dapat berupa NULL.
[out, optional] PropertyBuffer
Penunjuk ke buffer yang menerima properti yang sedang diambil. Jika parameter ini diatur ke NULL, dan PropertyBufferSize juga diatur ke nol, fungsi mengembalikan ukuran yang diperlukan untuk buffer di RequiredSize.
[in] PropertyBufferSize
Ukuran, dalam byte, dari buffer PropertyBuffer .
[out, optional] RequiredSize
Penunjuk ke variabel jenis DWORD yang menerima ukuran yang diperlukan, dalam byte, dari buffer PropertyBuffer yang diperlukan untuk menyimpan data untuk properti yang diminta. Parameter ini bersifat opsional dan dapat berupa NULL.
Mengembalikan nilai
SetupDiGetDeviceRegistryProperty mengembalikan TRUE jika panggilan berhasil. Jika tidak, ia mengembalikan FALSE dan kesalahan yang dicatat dapat diambil dengan melakukan panggilan ke GetLastError. SetupDiGetDeviceRegistryProperty mengembalikan kode kesalahan ERROR_INVALID_DATA jika properti yang diminta tidak ada untuk perangkat atau jika data properti tidak valid.
Keterangan
Catatan
Header setupapi.h mendefinisikan SetupDiGetDeviceRegistryProperty sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preproscessor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.
Persyaratan
Persyaratan | Nilai |
---|---|
Klien minimum yang didukung | Tersedia di Microsoft Windows 2000 dan versi Windows yang lebih baru. |
Target Platform | DesktopUntuk universal, panggil CM_Get_DevNode_Registry_Property |
Header | setupapi.h (termasuk Setupapi.h) |
Pustaka | Setupapi.lib |
Lihat juga
SetupDiGetClassRegistryProperty