Funzione PowerReadDescription (powrprof.h)

Recupera la descrizione per l'impostazione di risparmio energia, il sottogruppo o lo schema specificati. Se il parametro SchemeGuid non è NULL , ma entrambi i parametri SubGroupOfPowerSettingsGuid e PowerSettingGuid sono NULL, verrà restituita la descrizione dello schema di alimentazione. Se i parametri SchemeGuid e SubGroupOfPowerSettingsGuid non sono NULL e il parametro PowerSettingGuid è NULL, verrà restituita la descrizione del sottogruppo. Se i parametri SchemeGuid, SubGroupOfPowerSettingsGuid e PowerSettingGuid non sono NULL, verrà restituita la descrizione dell'impostazione di risparmio energia.

Sintassi

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
);

Parametri

[in, optional] RootPowerKey

Questo parametro è riservato per uso futuro e deve essere impostato su NULL.

[in, optional] SchemeGuid

Identificatore dello schema di alimentazione.

[in, optional] SubGroupOfPowerSettingsGuid

Sottogruppo di impostazioni di risparmio energia. Questo parametro può essere uno dei valori seguenti definiti in WinNT.h. Usare NO_SUBGROUP_GUID per fare riferimento allo schema di alimentazione predefinito.

[in, optional] PowerSettingGuid

Identificatore dell'impostazione di risparmio energia utilizzata.

[out, optional] Buffer

Puntatore a un buffer che riceve la descrizione. Se questo parametro è NULL, il parametro BufferSize riceve le dimensioni del buffer necessarie. Le stringhe restituite sono tutte stringhe wide (Unicode).

[in, out] BufferSize

Puntatore a una variabile che contiene le dimensioni del buffer a cui punta il parametro Buffer .

Se il parametro Buffer è NULL, la funzione restituisce ERROR_SUCCESS e la variabile riceve le dimensioni del buffer necessarie.

Se le dimensioni del buffer specificate non sono sufficienti per contenere i dati richiesti, la funzione restituisce ERROR_MORE_DATA e la variabile riceve le dimensioni del buffer necessarie.

Valore restituito

Restituisce ERROR_SUCCESS (zero) se la chiamata ha avuto esito positivo e un valore diverso da zero se la chiamata non è riuscita. Se la dimensione del buffer specificata dal parametro BufferSize è troppo piccola, la funzione restituisce ERROR_SUCCESS e la DWORD a cui punta il parametro BufferSize viene riempita con le dimensioni del buffer necessarie.

Requisiti

Vedi anche

Funzioni di risparmio energia