Funzione GetTimeFormatA (datetimeapi.h)

Articolo
03/05/2024

Formatta l'ora come stringa temporale per le impostazioni locali specificate dall'identificatore. La funzione formatta un'ora specificata o l'ora del sistema locale.

Nota Per motivi di interoperabilità, l'applicazione deve preferire la funzione GetTimeFormatEx a GetTimeFormat 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 che verrà eseguita solo in Windows Vista e versioni successive deve usare GetTimeFormatEx.

Sintassi

int GetTimeFormatA(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpTime,
  [in, optional]  LPCSTR           lpFormat,
  [out, optional] LPSTR            lpTimeStr,
  [in]            int              cchTime
);

Parametri

[in] Locale

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

[in] dwFlags

Flag che specificano le opzioni di formato ora. Per definizioni dettagliate, vedere il parametro dwFlags di GetTimeFormatEx.

[in, optional] lpTime

Puntatore a una struttura SYSTEMTIME contenente le informazioni sull'ora da formattare. L'applicazione può impostare questo parametro su NULL se la funzione deve usare l'ora di sistema locale corrente.

[in, optional] lpFormat

Puntatore a un'immagine di formato da usare per formattare la stringa temporale. Se l'applicazione imposta questo parametro su NULL, la funzione formatta la stringa in base al formato dell'ora delle impostazioni locali specificate. Se l'applicazione non imposta il parametro su NULL, la funzione usa le impostazioni locali solo per informazioni non specificate nella stringa immagine di formato, ad esempio i marcatori di ora specifici delle impostazioni locali. Per informazioni sulla stringa di formato immagine, vedere la sezione Osservazioni.

[out, optional] lpTimeStr

Puntatore a un buffer in cui questa funzione recupera la stringa temporale formattata.

[in] cchTime

Dimensioni, in valori TCHAR, per il buffer della stringa di tempo indicato da lpTimeStr. In alternativa, l'applicazione può impostare questo parametro su 0. In questo caso, la funzione restituisce le dimensioni necessarie per il buffer della stringa di tempo e non usa il parametro lpTimeStr .

Valore restituito

Restituisce il numero di valori TCHAR recuperati nel buffer indicato da lpTimeStr. Se il parametro cchTime è impostato su 0, la funzione restituisce le dimensioni del buffer necessarie per contenere la stringa temporale formattata, incluso un carattere null di terminazione.

Questa 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_FLAGS. I valori specificati per i flag non sono validi.
ERROR_INVALID_PARAMETER. Uno dei valori dei parametri non è valido.
ERROR_OUTOFMEMORY. Spazio di archiviazione insufficiente per completare questa operazione.

Commenti

Vedere la sezione Osservazioni per GetTimeFormatEx.

Quando la versione ANSI di questa funzione viene usata con un identificatore delle impostazioni locali solo Unicode, la funzione può avere esito positivo perché il sistema operativo usa la tabella codici del sistema. Tuttavia, i caratteri non definiti nella tabella codici di sistema vengono visualizzati nella stringa come punto interrogativo (?).

A partire da Windows 8: GetTimeFormat viene dichiarato in Datetimeapi.h. Prima di Windows 8, è stato dichiarato in Winnls.h.

Nota

L'intestazione datetimeapi.h definisce GetTimeFormat come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	datetimeapi.h
Libreria	Kernel32.lib
DLL	Kernel32.dll

Vedere anche

GetDateFormat

GetLocaleInfo

GetTimeFormatEx

Supporto per la lingua nazionale

Funzioni di supporto per il linguaggio nazionale

Condividi tramite