Compartilhar via

função StringCchVPrintf_lExA (strsafe.h)

  • Artigo

Grava dados formatados na cadeia de caracteres especificada usando um ponteiro para uma lista de argumentos. O tamanho do buffer de destino é fornecido à função para garantir que ele não escreva além do final desse buffer.

StringCchVPrintf_lEx é semelhante a StringCchVPrintfEx , mas inclui um parâmetro para informações de localidade.

Sintaxe

STRSAFEAPI StringCchVPrintf_lExA(
  [out]           STRSAFE_LPSTR                                  pszDest,
  [in]            size_t                                         cchDest,
  [out]           STRSAFE_LPSTR                                  *ppszDestEnd,
  [out, optional] size_t                                         *pcchRemaining,
  [in]            DWORD                                          dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]            _locale_t                                      locale,
  [in]            va_list                                        argList
);

Parâmetros

[out] pszDest

O buffer de destino, que recebe a cadeia de caracteres formatada e terminada em nulo criada a partir de pszFormat e argList.

[in] cchDest

O tamanho do buffer de destino, em caracteres. Esse valor deve ser suficientemente grande para acomodar a cadeia de caracteres formatada final mais 1 para considerar o caractere nulo de terminação. O número máximo de caracteres permitidos é STRSAFE_MAX_CCH.

[out] ppszDestEnd

O endereço de um ponteiro para o final do pszDest. Se ppszDestEnd não for NULL e todos os dados forem copiados para o buffer de destino, isso apontará para o caractere nulo de terminação no final da cadeia de caracteres.

[out, optional] pcchRemaining

O número de caracteres não utilizados no pszDest, incluindo o caractere nulo de terminação. Se pcchRemaining for NULL, a contagem não será mantida ou retornada.

[in] dwFlags

Um ou mais dos valores a seguir.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Se a função for bem-sucedida, o byte baixo de dwFlags (0) será usado para preencher a parte não inicializada do pszDest após o caractere nulo de terminação.
STRSAFE_IGNORE_NULLS
0x00000100
 Tratar ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT(")).
STRSAFE_FILL_ON_FAILURE
0x00000400
 Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer pszDest e o buffer será encerrado em nulo. No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER , qualquer cadeia de caracteres truncada retornada é substituída.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Se a função falhar, pszDest será definido como uma cadeia de caracteres vazia (TEXT("")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER , qualquer cadeia de caracteres truncada é substituída.
STRSAFE_NO_TRUNCATION
0x00001000
 Como no caso de STRSAFE_NULL_ON_FAILURE, se a função falhar, pszDest será definido como uma cadeia de caracteres vazia (TEXT("")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER , qualquer cadeia de caracteres truncada é substituída.

[in] pszFormat

A cadeia de caracteres de formato. Essa cadeia de caracteres deve ser terminada em nulo. Para obter mais informações, consulte Sintaxe de especificação de formato.

[in] locale

O objeto local. Para obter mais informações, consulte _create_locale.

[in] argList

Os argumentos a serem inseridos na cadeia de caracteres pszFormat .

Valor retornado

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use as macros SUCCEEDED e FAILED para testar o valor retornado dessa função.

Código de retorno Descrição
S_OK
 Havia espaço suficiente para o resultado ser copiado para pszDest sem truncamento e o buffer foi encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER
 O valor em cchDest é 0 ou maior que STRSAFE_MAX_CCH ou o buffer de destino já está cheio.
STRSAFE_E_INSUFFICIENT_BUFFER
 Falha na operação de cópia devido a espaço em buffer insuficiente. Dependendo do valor de dwFlags, o buffer de destino pode conter uma versão truncada e terminada em nulo do resultado pretendido. Em situações em que o truncamento é aceitável, isso pode não ser necessariamente visto como uma condição de falha.

Comentários

Para obter mais informações sobre va_lists, consulte as convenções definidas em Stdarg.h.

O comportamento será indefinido se as cadeias de caracteres apontadas por pszDest, pszFormat ou quaisquer cadeias de caracteres de argumento se sobrepõem.

Nem pszFormat nem pszDest devem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS seja especificado, nesse caso, ambos podem ser NULL. No entanto, um erro devido ao espaço insuficiente ainda pode ser retornado, mesmo que os valores NULL sejam ignorados.

Para usar essa função, você deve definir a macro a seguir no arquivo de cabeçalho, antes de incluir StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Observação

O cabeçalho strsafe.h define StringCchVPrintf_lEx 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 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 strsafe.h