Funzione GetCalendarDateFormatEx

Deprecato. Recupera una stringa di data formattata correttamente per le impostazioni locali specificate usando la data e il calendario specificati. L'utente può specificare il formato di data breve, il formato di data lunga, il formato del mese dell'anno o un modello di formato personalizzato.

Nota

Questa funzione può recuperare i dati che cambiano tra le versioni, ad esempio a causa di impostazioni locali personalizzate. Se l'applicazione deve mantenere o trasmettere dati, vedere Uso di dati locali persistenti.

 

Sintassi

BOOL GetCalendarDateFormatEx(
  _In_        LPCWSTR       lpszLocale,
  _In_        DWORD         dwFlags,
  _In_  const LPCALDATETIME lpCalDateTime,
  _In_        LPCWSTR       lpFormat,
  _Out_       LPWSTR        lpDateStr,
  _In_        int           cchDate
);

Parametri

lpszLocale [in]

Puntatore a un nome delle impostazioni locali o uno dei valori predefiniti seguenti.

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

dwFlags [in]

Flag che specificano le opzioni di formato data. Se lpFormat non è impostato su NULL, questo parametro deve essere impostato su 0. Se lpFormat è impostato su NULL, l'applicazione può specificare una combinazione dei valori seguenti e LOCALE_NOUSEROVERRIDE.

Valore	Significato
DATE_SHORTDATE	Usare il formato di data breve. Questo è il valore predefinito. Questo valore non può essere usato con DATE_LONGDATE o DATE_YEARMONTH.
DATE_LONGDATE	Usare il formato di data lunga. Questo valore non può essere usato con DATE_SHORTDATE o DATE_YEARMONTH.
DATE_YEARMONTH	Usare il formato anno/mese. Questo valore non può essere usato con DATE_SHORTDATE o DATE_LONGDATE.
DATE_LTRREADING	Aggiungere segni per il layout di lettura da sinistra a destra. Questo valore non può essere usato con DATE_RTLREADING.
DATE_RTLREADING	Aggiungere segni per il layout di lettura da destra a sinistra. Questo valore non può essere usato con DATE_LTRREADING

 

lpCalDateTime [in]

Puntatore a una struttura CALDATETIME che contiene le informazioni sulla data e sul calendario da formattare.

lpFormat [in]

Puntatore a una stringa di immagine di formato usata per formare la stringa di data. I valori possibili per la stringa di immagine di formato sono definiti in Day , Month, Year e Era Format Pictures.

La stringa di immagine di formato deve essere terminata con valore Null. La funzione usa le impostazioni locali solo per informazioni non specificate nella stringa di immagine di formato, ad esempio i nomi giorno e mese per le impostazioni locali. L'applicazione imposta questo parametro su NULL se la funzione deve usare il formato data delle impostazioni locali specificate.

lpDateStr [out]

Puntatore a un buffer in cui questa funzione riceve la stringa di data formattata.

cchDate [in]

Dimensioni, in caratteri, del buffer lpDateStr . In alternativa, l'applicazione può impostare questo parametro su 0. In questo caso, la funzione restituisce il numero di caratteri necessari per contenere la stringa di data formattata e il parametro lpDateStr non viene usato.

Valore restituito

Restituisce il numero di caratteri scritti nel buffer lpDateStr se riuscito. Se il parametro cchDate è impostato su 0, la funzione restituisce il numero di caratteri necessari per contenere la stringa di data formattata, incluso il carattere Null di terminazione.

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

• ERROR_DATE_OUT_OF_RANGE. La data specificata non era compreso nell'intervallo.
• ERROR_INSUFFICIENT_BUFFER. Una dimensione del buffer fornita non è stata sufficiente oppure è stata impostata in modo errato su NULL.
• ERROR_INVALID_FLAGS. I valori forniti per i flag non sono validi.
• ERROR_INVALID_PARAMETER. Uno dei valori dei parametri non è valido.

Commenti

La data più recente supportata da questa funzione è il 1° gennaio 1601.

Questa funzione non ha un file di intestazione o un file di libreria associato. L'applicazione può chiamare LoadLibrary con il nome dll (Kernel32.dll) per ottenere un handle del modulo. Può quindi chiamare GetProcAddress con tale handle di modulo e il nome di questa funzione per ottenere l'indirizzo della funzione.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
DLL	Kernel32.dll

Vedere anche

Supporto per la lingua nazionale

Funzioni di supporto del linguaggio nazionale

Immagini di formato Day, Month, Year e Era

NLS: Esempio di API basate su nome

EnumDateFormatsExEx

GetDateFormat

GetDateFormatEx

CALDATETIME