Fonction PowerReadFriendlyName (powrprof.h)

Article
03/01/2024

Récupère le nom convivial pour le paramètre d’alimentation, le sous-groupe ou le schéma spécifiés. Si le paramètre SchemeGuid n’a pas la valeur NULL , mais que les paramètres SubGroupOfPowerSettingsGuid et PowerSettingGuid ont tous deux la valeur NULL, le nom convivial du schéma d’alimentation est retourné. Si les paramètres SchemeGuid et SubGroupOfPowerSettingsGuid ne sont pas NULL et que le paramètre PowerSettingGuid a la valeur NULL, le nom convivial du sous-groupe est retourné. Si les paramètres SchemeGuid, SubGroupOfPowerSettingsGuid et PowerSettingGuid ne sont pas NULL, le nom convivial du paramètre d’alimentation est retourné.

Syntaxe

DWORD PowerReadFriendlyName(
  [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
);

Paramètres

[in, optional] RootPowerKey

Ce paramètre est réservé pour une utilisation ultérieure et doit être défini sur NULL.

[in, optional] SchemeGuid

Identificateur du schéma d’alimentation.

[in, optional] SubGroupOfPowerSettingsGuid

Sous-groupe des paramètres d’alimentation. Utilisez NO_SUBGROUP_GUID pour faire référence au schéma d’alimentation par défaut.

Valeur	Signification
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	Les paramètres de ce sous-groupe font partie du schéma d’alimentation par défaut.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	Les paramètres de ce sous-groupe contrôlent la configuration de la gestion de l’alimentation des lecteurs de disque dur du système.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	Les paramètres de ce sous-groupe contrôlent la configuration des boutons d’alimentation système.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	Les paramètres de ce sous-groupe contrôlent la configuration des fonctionnalités de gestion de l’alimentation du processeur.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	Les paramètres de ce sous-groupe contrôlent la configuration des fonctionnalités de gestion de l’alimentation vidéo.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	Les paramètres de ce sous-groupe contrôlent les points de déclenchement et les actions de l’alarme de batterie.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	Les paramètres de ce sous-groupe contrôlent les paramètres de veille système.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	Les paramètres de ce sous-groupe contrôlent les paramètres PCI Express.

[in, optional] PowerSettingGuid

Identificateur du paramètre d’alimentation utilisé.

[out, optional] Buffer

Pointeur vers une mémoire tampon qui reçoit le nom convivial. Si ce paramètre a la valeur NULL, le paramètre BufferSize reçoit la taille de mémoire tampon requise. Les chaînes retournées sont toutes des chaînes larges (Unicode).

[in, out] BufferSize

Pointeur vers une variable qui contient la taille de la mémoire tampon pointée par le paramètre Buffer .

Si le paramètre Buffer a la valeur NULL, la fonction retourne ERROR_SUCCESS et la variable reçoit la taille de mémoire tampon requise.

Si la taille de mémoire tampon spécifiée n’est pas suffisamment grande pour contenir les données demandées, la fonction retourne ERROR_MORE_DATA et la variable reçoit la taille de mémoire tampon requise.

Valeur retournée

Retourne ERROR_SUCCESS (zéro) si l’appel a réussi, et une valeur différente de zéro si l’appel a échoué. Si la taille de la mémoire tampon spécifiée par le paramètre BufferSize est trop petite, ERROR_MORE_DATA sera retourné et le DWORD pointé par le paramètre BufferSize sera rempli avec la taille de mémoire tampon requise.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	powrprof.h
Bibliothèque	PowrProf.lib
DLL	PowrProf.dll

Voir aussi

Fonctions de gestion de l’alimentation

Partager via