SetupDiGetHwProfileFriendlyNameA (setupapi.h)

Fungsi SetupDiGetHwProfileFriendlyName mengambil nama yang mudah diingat yang terkait dengan ID profil perangkat keras.

Sintaksis

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize
);

Parameter

[in] HwProfile

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 string untuk menerima nama yang mudah diingat.

[in] FriendlyNameSize

Ukuran, dalam karakter, dari buffer FriendlyName.

[out, optional] RequiredSize

Pointer ke variabel jenis DWORD yang menerima jumlah karakter yang diperlukan untuk mengambil nama yang mudah diingat (termasuk terminator NULL).

Mengembalikan nilai

Fungsi mengembalikan TRUE jika berhasil. Jika tidak, ini mengembalikan FALSE dan kesalahan yang dicatat dapat diambil dengan melakukan panggilan ke GetLastError.

Komentar

Panggil SetupDiGetHwProfileFriendlyNameEx untuk mendapatkan nama yang mudah diingat dari ID profil perangkat keras di komputer jarak jauh.

Nota

Header setupapi.h menentukan SetupDiGetHwProfileFriendlyName 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

Syarat	Nilai
klien minimum yang didukung	Tersedia di Microsoft Windows 2000 dan versi Windows yang lebih baru.
Platform Target	Desktop
Header	setupapi.h (termasuk Setupapi.h)
Pustaka	Setupapi.lib

Lihat juga

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList