Função EnumCalendarInfoExA (winnls.h)

Artigo
08/27/2023

Enumera informações de calendário para uma localidade especificada pelo identificador.

Nota Qualquer aplicativo executado somente no Windows Vista e posterior deve usar EnumCalendarInfoExEx em preferência para essa função.

Sintaxe

BOOL EnumCalendarInfoExA(
  [in] CALINFO_ENUMPROCEXA lpCalInfoEnumProcEx,
  [in] LCID                Locale,
  [in] CALID               Calendar,
  [in] CALTYPE             CalType
);

Parâmetros

[in] lpCalInfoEnumProcEx

Ponteiro para uma função de retorno de chamada definida pelo aplicativo. Para obter mais informações, consulte EnumCalendarInfoProcEx.

[in] Locale

Identificador de localidade que especifica a localidade para a qual recuperar informações de calendário. Você pode usar a macro MAKELCID para criar um identificador ou usar um dos seguintes valores predefinidos.

Windows Vista e posterior: Também há suporte para os seguintes identificadores de localidade personalizados.

[in] Calendar

Identificador de calendário que especifica o calendário para o qual as informações são solicitadas. Observe que esse identificador pode ser ENUM_ALL_CALENDARS, para enumerar todos os calendários associados à localidade.

[in] CalType

Tipo de informações de calendário. Para obter mais informações, consulte Informações de tipo de calendário. Somente um tipo de calendário pode ser especificado por chamada para essa função, exceto quando indicado.

Valor retornado

Retorna um valor diferente de zero se tiver êxito ou 0 de outra forma. Para obter informações de erro estendidas, o aplicativo pode chamar GetLastError, que pode retornar um dos seguintes códigos de erro:

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

Essa função enumera informações de calendário para todos os calendários aplicáveis para a localidade especificada ou para um único calendário solicitado, dependendo do valor do parâmetro Calendar . A função enumera as informações do calendário chamando a função de retorno de chamada definida pelo aplicativo especificada. Ele passa a função de retorno de chamada um ponteiro para um buffer que contém as informações de calendário solicitadas. Esse processo continua até que EnumCalendarInfoEx encontre o último calendário aplicável ou a função de retorno de chamada retorne FALSE.

Essa função pode enumerar dados de localidades personalizadas. Não há garantia de que os dados sejam iguais de computador para computador ou entre execuções de um aplicativo. Se o aplicativo precisar persistir ou transmitir dados, consulte Usando dados de localidade persistente.

Quando a versão ANSI dessa função é usada com um identificador de localidade somente Unicode, a função pode ser bem-sucedida porque o sistema operacional usa a página de código do sistema. No entanto, caracteres indefinidos na página de código do sistema aparecem na cadeia de caracteres como um ponto de interrogação (?).

Observação

O cabeçalho winnls.h define EnumCalendarInfoEx como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos


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