Funzione GetDurationFormat (winnls.h)

Articolo
03/04/2024

Formatta una durata di tempo come stringa temporale per le impostazioni locali specificate dall'identificatore.

Nota Per motivi di interoperabilità, l'applicazione deve preferire la funzione GetDurationFormatEx a GetDurationFormat perché Microsoft sta eseguendo la migrazione all'uso dei nomi delle impostazioni locali anziché degli identificatori delle impostazioni locali per le nuove impostazioni locali. Qualsiasi applicazione eseguita solo in Windows Vista e versioni successive deve usare GetDurationFormatEx.

Sintassi

int GetDurationFormat(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDuration,
  [in]            ULONGLONG        ullDuration,
  [in, optional]  LPCWSTR          lpFormat,
  [out, optional] LPWSTR           lpDurationStr,
  [in]            int              cchDuration
);

Parametri

[in] Locale

Identificatore delle impostazioni locali che specifica le impostazioni locali per cui questa funzione formatta la durata. È possibile utilizzare la macro MAKELCID per creare un identificatore delle impostazioni locali o usare uno dei valori predefiniti seguenti.

Windows Vista e versioni successive: Sono supportati anche gli identificatori di impostazioni locali personalizzati seguenti.

[in] dwFlags

Flag che specificano le opzioni della funzione. Se lpFormat non è impostato su NULL, questo parametro deve essere impostato su 0. Se lpFormat è impostato su NULL, l'applicazione può specificare LOCALE_NOUSEROVERRIDE per formattare la stringa usando il formato di durata predefinito del sistema per le impostazioni locali specificate.

Attenzione L'uso di LOCALE_NOUSEROVERRIDE è fortemente sconsigliato perché disabilita le preferenze dell'utente.

[in, optional] lpDuration

Puntatore a una struttura SYSTEMTIME contenente le informazioni sulla durata del tempo da formattare. Se questo puntatore è NULL, la funzione ignora questo parametro e usa ullDuration.

[in] ullDuration

Intero senza segno a 64 bit che rappresenta il numero di intervalli di 100 nanosecondi nella durata. Se sono presenti sia lpDuration che ullDuration , lpDuration ha la precedenza. Se lpDuration è impostato su NULL e ullDuration è impostato su 0, la durata è zero.

[in, optional] lpFormat

Puntatore alla stringa di formato. Per informazioni dettagliate, vedere il parametro lpFormat di GetDurationFormatEx.

[out, optional] lpDurationStr

Puntatore al buffer in cui la funzione recupera la stringa di durata.

In alternativa, questo parametro può contenere NULL se cchDuration è impostato su 0. In questo caso, la funzione restituisce le dimensioni necessarie per il buffer della stringa di durata.

[in] cchDuration

Dimensioni, in caratteri, del buffer indicato da lpDurationStr.

In alternativa, l'applicazione può impostare questo parametro su 0. In questo caso, la funzione recupera NULL in lpDurationStr e restituisce le dimensioni necessarie per il buffer della stringa di durata.

Valore restituito

Restituisce il numero di caratteri recuperati nel buffer indicato da lpDurationStr in caso di esito positivo. Se lpDurationStr è impostato su NULL e cchDuration è impostato su 0, la funzione restituisce le dimensioni necessarie per il buffer della stringa di durata, incluso il carattere di terminazione Null. Ad esempio, se nel buffer vengono scritti 10 caratteri, la funzione restituisce 11 per includere il carattere Null di terminazione.

La funzione restituisce 0 se non riesce. Per ottenere informazioni estese sull'errore, l'applicazione può chiamare GetLastError, che può restituire uno dei codici di errore seguenti:

ERROR_INSUFFICIENT_BUFFER. Le dimensioni del buffer fornite non sono sufficienti o non sono state impostate correttamente su NULL.
ERROR_INVALID_PARAMETER. Uno dei valori dei parametri non è valido.

Commenti

Vedere la sezione Osservazioni per GetDurationFormatEx.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winnls.h (include Windows.h)
Libreria	Kernel32.lib
DLL	Kernel32.dll