Fungsi PowerReadDescription (powrprof.h)
Mengambil deskripsi untuk pengaturan daya, subgrup, atau skema yang ditentukan. Jika parameter SchemeGuid bukan NULL tetapi parameter SubGroupOfPowerSettingsGuid dan PowerSettingGuid adalah NULL, deskripsi skema daya akan dikembalikan. Jika parameter SchemeGuid dan SubGroupOfPowerSettingsGuid bukan NULL dan parameter PowerSettingGuid adalah NULL, deskripsi subgrup akan dikembalikan. Jika parameter SchemeGuid, SubGroupOfPowerSettingsGuid, dan PowerSettingGuid bukan NULL, deskripsi pengaturan daya akan dikembalikan.
Sintaks
DWORD PowerReadDescription(
[in, optional] HKEY RootPowerKey,
[in, optional] const GUID *SchemeGuid,
[in, optional] const GUID *SubGroupOfPowerSettingsGuid,
[in, optional] const GUID *PowerSettingGuid,
[out, optional] PUCHAR Buffer,
[in, out] LPDWORD BufferSize
);
Parameter
[in, optional] RootPowerKey
Parameter ini dicadangkan untuk digunakan di masa mendatang dan harus diatur ke NULL.
[in, optional] SchemeGuid
Pengidentifikasi skema daya.
[in, optional] SubGroupOfPowerSettingsGuid
Subgrup pengaturan daya. Parameter ini dapat menjadi salah satu nilai berikut yang ditentukan dalam WinNT.h. Gunakan NO_SUBGROUP_GUID untuk merujuk ke skema daya default.
[in, optional] PowerSettingGuid
Pengidentifikasi pengaturan daya yang sedang digunakan.
[out, optional] Buffer
Penunjuk ke buffer yang menerima deskripsi. Jika parameter ini NULL, parameter BufferSize menerima ukuran buffer yang diperlukan. String yang dikembalikan adalah semua string lebar (Unicode).
[in, out] BufferSize
Penunjuk ke variabel yang berisi ukuran buffer yang diacu oleh parameter Buffer .
Jika parameter Bufferadalah NULL, fungsi mengembalikan ERROR_SUCCESS dan variabel menerima ukuran buffer yang diperlukan.
Jika ukuran buffer yang ditentukan tidak cukup besar untuk menyimpan data yang diminta, fungsi mengembalikan ERROR_MORE_DATA dan variabel menerima ukuran buffer yang diperlukan.
Nilai kembali
Mengembalikan ERROR_SUCCESS (nol) jika panggilan berhasil, dan nilai bukan nol jika panggilan gagal. Jika ukuran buffer yang ditentukan oleh parameter BufferSize terlalu kecil, fungsi mengembalikan ERROR_SUCCESS dan DWORD yang ditunjukkan oleh parameter BufferSize diisi dengan ukuran buffer yang diperlukan.
Persyaratan
Persyaratan | Nilai |
---|---|
Klien minimum yang didukung | Windows Vista [hanya aplikasi desktop] |
Server minimum yang didukung | Windows Server 2008 [hanya aplikasi desktop] |
Target Platform | Windows |
Header | powrprof.h |
Pustaka | PowrProf.lib |
DLL | PowrProf.dll |