Функция UtilAssembleStringsWithAlloc

Статья
06/13/2023

Функция UtilAssembleStringsWithAlloc выделяет строку и форматирует ее с помощью строк, предоставленных строковой таблицей. Эта функция использует StringCchPrintf для создания форматируемой строки.

Синтаксис

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

Параметры

Буфер [out]

Тип: LPWSTR*

Расположение, в котором будет размещена только что выделенная строка. Если строка больше не нужна, ее необходимо освободить с помощью CoTaskMemFree.

BufferMax [in]

Тип: UINT

Максимальное число символов, разрешенных в строке, выделенной buffer. Если итоговая отформатированная строка длиннее указанного числа символов, она усекается и завершается значением NULL.

Примечание

Этот параметр может быть не равен нулю.

InputFormat [in]

Тип: LPCWSTR

Строковый ресурс из таблицы строк, представляющий параметр формата, передаваемый в StringCchPrintf. Он создается с помощью MAKEINTRESOURCE.

Формат строки ресурса должен указывать либо параметр формата, принимаюющий широкую строку, либо параметр формата, который принимает длинную и широкую строку без знака.

InputString [in]

Тип: LPCWSTR

Строковый ресурс из таблицы строк, представляющий аргумент, передаваемый в StringCchPrintf вместо широкой строки в параметре format. Он создается с помощью MAKEINTRESOURCE.

AdditionalArgument [in]

Тип: BOOLEAN

Значение true, если Параметр AdditionalValue должен быть передан в качестве первого аргумента форматирования в StringCchPrintf; в противном случае — false (и передается только строка ресурса , определяемая InputString ).

AdditionalValue [in]

Тип: ULONG

Значение, передаваемое в качестве первого аргумента форматирования в StringCchPrintf , если параметр AdditionalArgument имеет значение true.

Возвращаемое значение

Тип: HRESULT

Возможные возвращаемые значения включают, помимо прочего, следующие.

Код возврата	Описание
S_OK	Операция успешно выполнена.
E_INVALIDARG	Один или несколько параметров указаны неправильно.

Требования

Требование	Значение
Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Заголовок	Ndattributils.h

См. также раздел

UtilStringCopyWithAlloc
UtilLoadStringWithAlloc
StringCchPrintf
MAKEINTRESOURCE
CoTaskMemFree

Поделиться через