Função GetTimeFormatWrapW

[GetTimeFormatWrapW está disponível para uso no Windows XP. Ele pode não estar disponível em versões subsequentes. Você deve usar GetTimeFormatW em seu lugar.]

Formata a hora como uma cadeia de caracteres de tempo para uma localidade especificada. A função formata uma hora especificada ou a hora do sistema local.

Observação

GetTimeFormatWrapW é um wrapper para a função GetTimeFormatW . Consulte a página GetTimeFormat para obter mais notas de uso.

 

Sintaxe

int GetTimeFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpTime,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzTimeStr,
  _In_        int        cchTime
);

Parâmetros

Localidade [in]

Tipo: LCID

Especifica a localidade para a qual a cadeia de caracteres de tempo deve ser formatada. Se pwzFormat for NULL, a função formata a cadeia de caracteres de acordo com o formato de hora para essa localidade. Se pwzFormat não for NULL, a função usará a localidade somente para informações não especificadas na cadeia de caracteres de imagem de formato (por exemplo, os marcadores de tempo da localidade).

Esse parâmetro pode ser um identificador de localidade criado pela macro MAKELCID ou um dos valores predefinidos a seguir.

LOCALE_SYSTEM_DEFAULT

Localidade padrão do sistema.

LOCALE_USER_DEFAULT

Localidade do usuário padrão.

dwFlags [in]

Tipo: DWORD

Especifica várias opções de função. Você pode especificar uma combinação dos valores a seguir.

LOCALE_NOUSEROVERRIDE

Se definida, a função formata a cadeia de caracteres usando o formato de hora padrão do sistema para a localidade especificada. Se não estiver definida, a função formata a cadeia de caracteres usando qualquer substituição de usuário para o formato de hora padrão da localidade. Esse sinalizador só poderá ser definido se pwzFormat for NULL.

LOCALE_USE_CP_ACP

Usa a página de código ANSI do sistema para tradução de cadeia de caracteres em vez da página de código de localidade.

TIME_NOMINUTESORSECONDS

Não usa minutos ou segundos.

TIME_NOSECONDS

Não usa segundos.

TIME_NOTIMEMARKER

Não usa um marcador de tempo.

TIME_FORCE24HOURFORMAT

Sempre usa um formato de tempo de 24 horas.

lpTime [in]

Tipo: const SYSTEMTIME*

Um ponteiro para uma estrutura SYSTEMTIME que contém as informações de tempo a serem formatadas. Se esse ponteiro for NULL, a função usará a hora atual do sistema local.

pwzFormat [in]

Tipo: LPCWSTR

Um ponteiro para um formato a ser usado para formar a cadeia de caracteres de tempo. Se pwzFormat for NULL, a função usará o formato de hora da localidade especificada. Consulte GetTimeFormat para obter mais detalhes.

pwzTimeStr [out]

Tipo: LPWSTR

Um ponteiro para um buffer que recebe a cadeia de caracteres de tempo formatada.

cchTime [in]

Tipo: int

O tamanho, em caracteres, do buffer pwzTimeStr . Se cchTime for zero, a função retornará o número de caracteres necessários para manter a cadeia de caracteres de tempo formatada e o buffer apontado por pwzTimeStr não será usado.

Valor retornado

Tipo: int

Se a função for bem-sucedida, o valor retornado será o número de caracteres gravados no buffer apontado por pwzTimeStr. Se o parâmetro cchTime for zero, o valor retornado será o número de caracteres necessários para manter a cadeia de caracteres de tempo formatada. A contagem inclui o caractere nulo de terminação.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError. GetLastError pode retornar um dos seguintes códigos de erro.

ERROR_INSUFFICIENT_BUFFER

ERROR_INVALID_FLAGS

ERROR_INVALID_PARAMETER

Comentários

GetTimeFormatWrapW fornece a capacidade de usar cadeias de caracteres Unicode em sistemas operacionais anteriores ao Windows XP. O método preferencial é usar GetTimeFormatW em conjunto com a MSLU (Microsoft Layer for Unicode).

GetTimeFormatWrapW deve ser chamado diretamente de Shlwapi.dll, usando o ordinal 310.

Requisitos

Requisito Valor
Cliente mínimo com suporte
 Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
 Windows Server 2003 [somente aplicativos da área de trabalho]
DLL
Shlwapi.dll (versão 5.0 ou posterior)

Confira também

Gettimeformat

 

 

  • Last updated on