Função GetDateFormatWrapW

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

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

Observação

GetDateFormatWrapW é um wrapper para a função GetDateFormatW . Consulte a página GetDateFormat para obter mais notas de uso.

 

Sintaxe

int GetDateFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpDate,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzDateStr,
  _In_        int        cchDate
);

Parâmetros

Localidade [in]

Tipo: LCID

A localidade para a qual a cadeia de caracteres de data deve ser formatada. Se pwzFormat for NULL, a função formata a cadeia de caracteres de acordo com o formato de data dessa 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 nomes de dia e mês 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. Se pwzFormat não for NULL, esse parâmetro deverá ser zero. Se pwzFormat for NULL, você poderá especificar uma combinação dos valores a seguir. Se você não especificar DATE_YEARMONTH, DATE_SHORTDATE ou DATE_LONGDATE e pwzFormat for NULL, DATE_SHORTDATE será usado como padrão.

LOCALE_NOUSEROVERRIDE

Se definida, a função formata a cadeia de caracteres usando o formato de data 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 data padrão da localidade.

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 da localidade.

DATE_SHORTDATE

Usa o formato de data abreviada. Esse valor não pode ser usado com DATE_LONGDATE ou DATE_YEARMONTH.

DATE_LONGDATE

Usa o formato de data longa. Esse valor não pode ser usado com DATE_SHORTDATE ou DATE_YEARMONTH.

DATE_YEARMONTH

Usa o formato ano/mês. Esse valor não pode ser usado com DATE_SHORTDATE ou DATE_LONGDATE.

DATE_USE_ALT_CALENDAR

Usa o calendário alternativo, se houver, para formatar a cadeia de caracteres de data. Se esse sinalizador for definido, a função usará o formato padrão para esse calendário alternativo, em vez de usar quaisquer substituições de usuário. As substituições de usuário serão usadas somente no caso de não haver um formato padrão para o calendário alternativo especificado.

DATE_LTRREADING

Adiciona marcas para layout de leitura da esquerda para a direita. Esse valor não pode ser usado com DATE_RTLREADING.

DATE_RTLREADING

Adiciona marcas para layout de leitura da direita para a esquerda. Esse valor não pode ser usado com DATE_LTRREADING.

lpDate [in]

Tipo: const SYSTEMTIME*

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

pwzFormat [in]

Tipo: LPCWSTR

Um ponteiro para uma imagem de formato a ser usada para formar a cadeia de caracteres de data. Se pwzFormat for NULL, a função usará o formato de data da localidade especificada. Consulte GetDateFormat para obter mais detalhes.

pwzDateStr [out]

Tipo: LPWSTR

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

cchDate [in]

Tipo: int

Especifica o tamanho, em caracteres, do buffer pwzDateStr . Se cchDate for zero, a função retornará o número de caracteres necessários para manter a cadeia de caracteres de data formatada e o buffer apontado por pwzDateStr 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 pwzDateStr. Se o parâmetro cchDate for zero, o valor retornado será o número de caracteres necessários para manter a cadeia de caracteres de data 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

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

GetDateFormatWrapW deve ser chamado diretamente de Shlwapi.dll, usando o ordinal 311.

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

Getdateformat

 

 

  • Last updated on