Função GetCalendarInfoEx (winnls.h)

  • Artigo

Recupera informações sobre um calendário para uma localidade especificada pelo nome.

Nota O aplicativo deve chamar essa função em preferência para GetCalendarInfo se projetado para ser executado somente no Windows Vista e posterior.

 
Nota Essa função pode recuperar dados que são alterados entre versões, por exemplo, devido a uma localidade personalizada. Se o aplicativo precisar persistir ou transmitir dados, consulte Usando dados de localidade persistente.
 

Sintaxe

int GetCalendarInfoEx(
  [in, optional]  LPCWSTR lpLocaleName,
  [in]            CALID   Calendar,
  [in, optional]  LPCWSTR lpReserved,
  [in]            CALTYPE CalType,
  [out, optional] LPWSTR  lpCalData,
  [in]            int     cchData,
  [out, optional] LPDWORD lpValue
);

Parâmetros

[in, optional] lpLocaleName

Ponteiro para um nome de localidade ou um dos seguintes valores predefinidos.

[in] Calendar

Identificador de calendário.

[in, optional] lpReserved

Reservados; deve ser NULL.

[in] CalType

Tipo de informação a ser recuperada. Para obter mais informações, consulte Informações de tipo de calendário.

ObservaçãoGetCalendarInfoEx retornará apenas uma cadeia de caracteres se esse parâmetro especificar CAL_IYEAROFFSETRANGE ou CAL_SERASTRING. Em ambos os casos, a era atual é retornada.
 
Para CAL_NOUSEROVERRIDE, a função ignora qualquer valor definido por SetCalendarInfo e usa as configurações de banco de dados para a localidade padrão do sistema atual. Esse tipo é relevante apenas na combinação CAL_NOUSEROVERRIDE | CAL_ITWODIGITYEARMAX. CAL_ITWODIGITYEARMAX é o único valor que pode ser definido por SetCalendarInfo.

[out, optional] lpCalData

Ponteiro para um buffer no qual essa função recupera os dados solicitados como uma cadeia de caracteres. Se CAL_RETURN_NUMBER for especificado em CalType, esse parâmetro deverá recuperar NULL.

[in] cchData

Tamanho, em caracteres, do buffer lpCalData . O aplicativo pode definir esse parâmetro como 0 para retornar o tamanho necessário para o buffer de dados do calendário. Nesse caso, o parâmetro lpCalData não é usado. Se CAL_RETURN_NUMBER for especificado para CalType, o valor de cchData deverá ser 0.

[out, optional] lpValue

Ponteiro para uma variável que recebe os dados solicitados como um número. Se CAL_RETURN_NUMBER for especificado em CalType, lpValue não deverá ser NULL. Se CAL_RETURN_NUMBER não for especificado em CalType, lpValue deverá ser NULL.

Valor retornado

Retorna o número de caracteres recuperados no buffer lpCalData se for bem-sucedido. Se a função for bem-sucedida, cchData será definido como 0 e CAL_RETURN_NUMBER não for especificado, o valor retornado será o tamanho do buffer necessário para armazenar as informações de localidade. Se a função for bem-sucedida, cchData será definido como 0 e CAL_RETURN_NUMBER for especificado, o valor retornado será o tamanho do valor gravado no parâmetro lpValue . Esse tamanho é sempre 2.

A função retornará 0 se não for bem-sucedida. Para obter informações de erro estendidas, o aplicativo pode chamar GetLastError, que pode retornar um dos seguintes códigos de erro:

  • ERROR_INSUFFICIENT_BUFFER. Um tamanho de buffer fornecido não era grande o suficiente ou foi definido incorretamente como NULL.
  • ERROR_INVALID_FLAGS. Os valores fornecidos para sinalizadores não eram válidos.
  • ERROR_INVALID_PARAMETER. Qualquer um dos valores de parâmetro era inválido.

Comentários

Nota Essa API está sendo atualizada para dar suporte à alteração da era japonesa de maio de 2019. Se o aplicativo der suporte ao calendário japonês, você deverá validar se ele lida corretamente com a nova era. Confira Preparar seu aplicativo para a alteração da era japonesa para obter mais informações.
 
A partir do Windows 8: Se o aplicativo passar marcas de idioma para essa função do namespace Windows.Globalization , ele deverá primeiro converter as marcas chamando ResolveLocaleName.

Requisitos

   
Cliente mínimo com suporte Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho winnls.h (inclua Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Informações de tipo de calendário

GetCalendarInfo

Suporte à linguagem nacional

Funções de suporte à linguagem nacional

SetCalendarInfo