Função EnumTimeFormatsA (winnls.h)

  • Artigo

Enumera os formatos de tempo disponíveis para uma localidade especificada pelo identificador.

Nota Por motivos de interoperabilidade, o aplicativo deve preferir a função EnumTimeFormatsEx a EnumTimeFormats porque a Microsoft está migrando para o uso de nomes de localidade em vez de identificadores de localidade para novas localidades. Qualquer aplicativo executado somente no Windows Vista e posterior deve usar EnumTimeFormatsEx.
 

Sintaxe

BOOL EnumTimeFormatsA(
  [in] TIMEFMT_ENUMPROCA lpTimeFmtEnumProc,
  [in] LCID              Locale,
  [in] DWORD             dwFlags
);

Parâmetros

[in] lpTimeFmtEnumProc

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

[in] Locale

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

[in] dwFlags

O formato de hora. Esse parâmetro pode especificar uma combinação de qualquer um dos valores a seguir.

Sinalizador Significado
0
 Use o formato de tempo longo do usuário atual.
TIME_NOSECONDS
 Windows 7 e posterior: use o formato de tempo curto do usuário atual.
Nota Esse valor não funcionará com a versão ANSI dessa função, EnumTimeFormatsA.
 
LOCAL_USE_CP_ACP
 Especificado com a versão ANSI dessa função, EnumTimeFormatsA (não recomendado), para usar a ACP (página de código ANSI) padrão do sistema do Windows em vez da página de código de localidade.

Retornar valor

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

A função enumera os formatos de tempo passando um ponteiro para um buffer que contém um formato de tempo para uma função de retorno de chamada definida pelo aplicativo. O primeiro valor na enumeração é sempre o valor padrão do usuário (substituição). A função continua a enumeração até que o formato da última vez seja encontrado 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 chamada pode ser bem-sucedida porque o sistema 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 ("?"). Observe que quaisquer novos valores para dwFlags introduzidos no futuro não funcionarão com a versão ANSI.

Observação

O cabeçalho winnls.h define EnumTimeFormats 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

Requisito Valor
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

Confira também

EnumTimeFormatsEx

EnumTimeFormatsProc

Suporte à linguagem nacional

Funções de suporte à linguagem nacional