SetupDiGetHwProfileFriendlyNameExA (setupapi.h)
Fungsi SetupDiGetHwProfileFriendlyNameEx mengambil nama ramah yang terkait dengan ID profil perangkat keras di komputer lokal atau jarak jauh.
Sintaks
WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
[in] DWORD HwProfile,
[out] PSTR FriendlyName,
[in] DWORD FriendlyNameSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Parameter
[in] HwProfile
Menyediakan ID profil perangkat keras yang terkait dengan nama yang mudah diingat untuk diambil. Jika parameter ini adalah 0, nama yang mudah diingat untuk profil perangkat keras saat ini diambil.
[out] FriendlyName
Penunjuk ke buffer karakter untuk menerima nama yang mudah diingat.
[in] FriendlyNameSize
Ukuran, dalam karakter, dari buffer FriendlyName .
[out, optional] RequiredSize
Penunjuk ke variabel untuk menerima jumlah karakter yang diperlukan untuk menyimpan nama yang mudah diingat (termasuk terminator NULL). Parameter ini bersifat opsional dan dapat berupa NULL.
[in, optional] MachineName
Penunjuk ke string yang dihentikan NULL yang berisi nama komputer jarak jauh tempat ID profil perangkat keras berada. Parameter ini bersifat opsional dan dapat berupa NULL. Jika MachineNameNULL, ID profil perangkat keras ada di komputer lokal.
Perhatian
Menggunakan fungsi ini untuk mengakses komputer jarak jauh tidak didukung dimulai dengan Windows 8 dan Windows Server 2012, karena fungsi ini telah dihapus.
Reserved
Harus NULL.
Mengembalikan nilai
Fungsi mengembalikan TRUE jika berhasil. Jika tidak, ia mengembalikan FALSE dan kesalahan yang dicatat dapat diambil dengan melakukan panggilan ke GetLastError.
Keterangan
Catatan
Header setupapi.h menentukan SetupDiGetHwProfileFriendlyNameEx sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor 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 | Desktop |
Header | setupapi.h (termasuk Setupapi.h) |
Pustaka | Setupapi.lib |