Função UtilAssembleStringsWithAlloc

Artigo
06/13/2023

A função UtilAssembleStringsWithAlloc aloca uma cadeia de caracteres e a formata usando cadeias de caracteres fornecidas pela tabela de cadeia de caracteres. Essa função usa StringCchPrintf para criar a cadeia de caracteres formatada.

Sintaxe

HRESULT UtilAssembleStringsWithAlloc(
  _Out_ LPWSTR  *Buffer,
  _In_  UINT    BufferMax,
  _In_  LPCWSTR InputFormat,
  _In_  LPCWSTR InputString,
  _In_  BOOLEAN AdditionalArgument,
  _In_  ULONG   AdditionalValue
);

Parâmetros

Buffer [out]

Tipo: LPWSTR*

O local em que a cadeia de caracteres recém-alocada será colocada. Quando a cadeia de caracteres não for mais necessária, ela deverá ser liberada com CoTaskMemFree.

BufferMax [in]

Tipo: UINT

O número máximo de caracteres permitidos na cadeia de caracteres alocada pelo Buffer. Se a cadeia de caracteres formatada resultante for maior que o número de caracteres especificado, ela será truncada e terminada em nulo.

Observação

Esse parâmetro pode não ser definido como zero.

InputFormat [in]

Tipo: LPCWSTR

Recurso de cadeia de caracteres fora da tabela de cadeia de caracteres que representa um parâmetro de formato passado para StringCchPrintf. Ele é construído usando MAKEINTRESOURCE.

O formato de cadeia de caracteres de recurso deve especificar um parâmetro de formato que usa uma cadeia de caracteres larga ou um parâmetro de formato que usa uma longa sem sinal e uma cadeia de caracteres larga.

InputString [in]

Tipo: LPCWSTR

Recurso de cadeia de caracteres fora da tabela de cadeia de caracteres que representa um argumento passado para StringCchPrintf no lugar da cadeia de caracteres larga no parâmetro format. Ele é construído usando MAKEINTRESOURCE.

AdditionalArgument [in]

Tipo: BOOLEAN

True se AdditionalValue deve ser passado como o primeiro argumento de formatação para StringCchPrintf; caso contrário, false (e somente a cadeia de caracteres de recurso identificada por InputString será passada).

AdditionalValue [in]

Tipo: ULONG

O valor a ser passado como o primeiro argumento de formatação para StringCchPrintf se AdditionalArgument for true.

Valor retornado

Tipo: HRESULT

Os valores retornados possíveis incluem, mas não se limitam a, o seguinte.

Código de retorno	Descrição
S_OK	A operação foi realizada com êxito.
E_INVALIDARG	Um ou mais parâmetros não foram fornecidos corretamente.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Cabeçalho	Ndattributils.h

Confira também

UtilStringCopyWithAlloc
UtilLoadStringWithAlloc
StringCchPrintf
MAKEINTRESOURCE
Cotaskmemfree

Compartilhar via