Funzione GetCalendarInfoA (winnls.h)
Recupera informazioni su un calendario per le impostazioni locali specificate dall'identificatore.
Sintassi
int GetCalendarInfoA(
[in] LCID Locale,
[in] CALID Calendar,
[in] CALTYPE CalType,
[out, optional] LPSTR lpCalData,
[in] int cchData,
[out, optional] LPDWORD lpValue
);
Parametri
[in] Locale
Identificatore delle impostazioni locali che specifica le impostazioni locali per cui recuperare le informazioni del calendario. È possibile utilizzare la macro MAKELCID per creare un identificatore delle impostazioni locali o usare uno dei valori predefiniti seguenti.
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] Calendar
Identificatore del calendario.
[in] CalType
Tipo di informazioni da recuperare. Per altre informazioni, vedere Informazioni sul tipo di calendario.
Per CAL_NOUSEROVERRIDE, la funzione ignora qualsiasi valore impostato da SetCalendarInfo e usa le impostazioni del database per le impostazioni locali predefinite del sistema corrente. Questo tipo è rilevante solo nella combinazione CAL_NOUSEROVERRIDE | CAL_ITWODIGITYEARMAX. CAL_ITWODIGITYEARMAX è l'unico valore che può essere impostato da SetCalendarInfo.
[out, optional] lpCalData
Puntatore a un buffer in cui questa funzione recupera i dati richiesti come stringa. Se CAL_RETURN_NUMBER è specificato in CalType, questo parametro deve recuperare NULL.
[in] cchData
Dimensioni, in caratteri, del buffer lpCalData . L'applicazione può impostare questo parametro su 0 per restituire le dimensioni necessarie per il buffer dei dati del calendario. In questo caso, il parametro lpCalData non viene usato. Se CAL_RETURN_NUMBER viene specificato per CalType, il valore di cchData deve essere 0.
[out, optional] lpValue
Puntatore a una variabile che riceve i dati richiesti come numero. Se CAL_RETURN_NUMBER è specificato in CalType, lpValue non deve essere NULL. Se CAL_RETURN_NUMBER non è specificato in CalType, lpValue deve essere NULL.
Valore restituito
Restituisce il numero di caratteri recuperati nel buffer lpCalData , con cchData impostato su un valore diverso da zero, in caso di esito positivo. Se la funzione ha esito positivo, cchData è impostato su 0 e CAL_RETURN_NUMBER non viene specificato, il valore restituito corrisponde alle dimensioni del buffer necessario per contenere le informazioni del calendario. Se la funzione ha esito positivo, cchData viene impostato su 0 e CAL_RETURN_NUMBER viene specificato, il valore restituito è la dimensione del valore recuperato in lpValue, ovvero 2 per la versione Unicode della funzione o 4 per la versione ANSI.
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.
Commenti
Nota
L'intestazione winnls.h definisce GetCalendarInfo 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 | winnls.h (include Windows.h) |
Libreria | Kernel32.lib |
DLL | Kernel32.dll |
Vedere anche
Informazioni sul tipo di calendario
Supporto per la lingua nazionale