função StringCbPrintf_lExW (strsafe.h)

Artigo
11/20/2024

Grava dados formatados na cadeia de caracteres especificada. O tamanho do buffer de destino é fornecido à função para garantir que ele não escreva após o final desse buffer.

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

Sintaxe

STRSAFEAPI StringCbPrintf_lExW(
  [out]           STRSAFE_LPWSTR                                  pszDest,
  [in]            size_t                                          cbDest,
  [out]           STRSAFE_LPWSTR                                  *ppszDestEnd,
  [out, optional] size_t                                          *pcbRemaining,
  [in]            DWORD                                           dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]            _locale_t                                       locale,
                  ...                                             
);

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 seus argumentos.

[in] cbDest

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

[out] ppszDestEnd

O endereço de um ponteiro até o final de 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 encerramento no final da cadeia de caracteres.

[out, optional] pcbRemaining

O número de bytes não utilizados em pszDest, incluindo aqueles usados para o caractere nulo de terminação. Se pcbRemaining 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 de pszDest após o término do caractere nulo.
STRSAFE_IGNORE_NULLS 0x00000100	Trate 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 de 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 é 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 de Sintaxe de Especificação de Formato.

[in] locale

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

...

Os argumentos a serem inseridos na cadeia de caracteres pszFormat .

Valor de retorno

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use o bem-sucedido e macros de COM FALHA para testar o valor retornado dessa função.

Código de retorno	Descrição
S_OK	Havia espaço suficiente para que o resultado fosse copiado para pszDest sem truncamento e o buffer foi encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER	O valor em cbDest é 0 ou maior que `STRSAFE_MAX_CCH * sizeof(TCHAR)`ou o buffer de destino já está cheio.
STRSAFE_E_INSUFFICIENT_BUFFER	A operação de cópia falhou devido ao 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.

Observações

O comportamento será indefinido se as cadeias de caracteres apontadas por pszDest, pszFormatou 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, embora valores de 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

Nota

O cabeçalho strsafe.h define StringCbPrintf_lEx como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2008 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	strsafe.h

Compartilhar via