Função EnumCalendarInfoExEx (winnls.h)

Artigo
03/13/2024

Enumera informações de calendário para uma localidade especificada por nome.

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

Nota Essa função pode enumerar 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

BOOL EnumCalendarInfoExEx(
  [in]           CALINFO_ENUMPROCEXEX pCalInfoEnumProcExEx,
  [in, optional] LPCWSTR              lpLocaleName,
  [in]           CALID                Calendar,
  [in, optional] LPCWSTR              lpReserved,
  [in]           CALTYPE              CalType,
  [in]           LPARAM               lParam
);

Parâmetros

[in] pCalInfoEnumProcExEx

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

[in, optional] lpLocaleName

Ponteiro para um nome de localidade ou um dos valores predefinidos a seguir.

[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, optional] lpReserved

Reservados; deve ser NULL.

[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.

[in] lParam

Parâmetro fornecido pelo aplicativo para passar para a função de retorno de chamada. Esse valor é especialmente útil para aplicativos multi-threaded.

Retornar valor

Retornará um valor diferente de zero se tiver êxito ou 0 caso contrário. 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, um identificador de calendário e um parâmetro definido pelo aplicativo que é útil para aplicativos multi-threaded. Esse processo continua até que EnumCalendarInfoExEx encontre o último calendário aplicável ou a função de retorno de chamada retorne FALSE.

Começando no 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

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