Función PowerReadPossibleFriendlyName (powrprof.h)
Recupera el nombre descriptivo de una de las posibles opciones de un valor de configuración de energía.
Sintaxis
DWORD PowerReadPossibleFriendlyName(
[in, optional] HKEY RootPowerKey,
[in, optional] const GUID *SubGroupOfPowerSettingsGuid,
[in, optional] const GUID *PowerSettingGuid,
[in] ULONG PossibleSettingIndex,
[out, optional] PUCHAR Buffer,
[in, out] LPDWORD BufferSize
);
Parámetros
[in, optional] RootPowerKey
Este parámetro está reservado para uso futuro y debe establecerse en NULL.
[in, optional] SubGroupOfPowerSettingsGuid
Subgrupo de la configuración de energía. Este parámetro puede ser uno de los siguientes valores definidos en WinNT.h. Use NO_SUBGROUP_GUID para hacer referencia al esquema de energía predeterminado.
[in, optional] PowerSettingGuid
Identificador de la configuración de energía.
[in] PossibleSettingIndex
Índice de base cero para la configuración posible.
[out, optional] Buffer
Puntero a un búfer que recibe el nombre descriptivo. Si este parámetro es NULL, el parámetro BufferSize recibe el tamaño de búfer necesario. Las cadenas devueltas son cadenas anchas (Unicode).
[in, out] BufferSize
Puntero a una variable que contiene el tamaño del búfer al que apunta el parámetro Buffer .
Si el parámetro Buffer es NULL, la función devuelve ERROR_SUCCESS y la variable recibe el tamaño de búfer necesario.
Si el tamaño de búfer especificado no es lo suficientemente grande como para contener los datos solicitados, la función devuelve ERROR_MORE_DATA y la variable recibe el tamaño de búfer necesario.
Valor devuelto
Devuelve ERROR_SUCCESS (cero) si la llamada se realizó correctamente y un valor distinto de cero si se produjo un error en la llamada. Si el tamaño del búfer especificado por el parámetro BufferSize es demasiado pequeño,
ERROR_MORE_DATA se devolverá y el DWORD al que apunta el parámetro BufferSize se rellenará con el tamaño de búfer necesario.
Requisitos
Requisito | Value |
---|---|
Cliente mínimo compatible | Windows Vista [solo aplicaciones de escritorio] |
Servidor mínimo compatible | Windows Server 2008 [solo aplicaciones de escritorio] |
Plataforma de destino | Windows |
Encabezado | powrprof.h |
Library | PowrProf.lib |
Archivo DLL | PowrProf.dll |