Compartir a través de

Función UtilAssembleStringsWithAlloc

  • Artículo

La función UtilAssembleStringsWithAlloc asigna una cadena y la da formato mediante cadenas proporcionadas por la tabla de cadenas. Esta función usa StringCchPrintf para crear la cadena con formato.

Sintaxis

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

Parámetros

Búfer [out]

Tipo: LPWSTR*

Ubicación donde se colocará la cadena recién asignada. Cuando la cadena ya no es necesaria, debe liberarse con CoTaskMemFree.

BufferMax [in]

Tipo: UINT

Número máximo de caracteres permitido en la cadena asignada por Buffer. Si la cadena con formato resultante es mayor que el número de caracteres especificado, se trunca y termina en null.

Nota

Este parámetro no se puede establecer en cero.

InputFormat [in]

Tipo: LPCWSTR

Recurso de cadena fuera de la tabla de cadenas que representa un parámetro de formato pasado a StringCchPrintf. Se construye mediante MAKEINTRESOURCE.

El formato de cadena de recurso debe especificar un parámetro de formato que toma una cadena ancha o un parámetro de formato que toma un long sin signo y una cadena ancha.

InputString [in]

Tipo: LPCWSTR

Recurso de cadena de la tabla de cadenas que representa un argumento pasado a StringCchPrintf en lugar de la cadena ancha en el parámetro format. Se construye mediante MAKEINTRESOURCE.

AdditionalArgument [in]

Tipo: BOOLEAN

True si AdditionalValue debe pasarse como primer argumento de formato a StringCchPrintf; de lo contrario, false (y solo se pasará la cadena de recurso identificada por InputString ).

AdditionalValue [in]

Tipo: ULONG

Valor que se va a pasar como primer argumento de formato a StringCchPrintf si AdditionalArgument es true.

Valor devuelto

Tipo: HRESULT

Entre los valores devueltos posibles se incluyen, entre otros, los siguientes.

Código devuelto Descripción
S_OK
 La operación se realizó correctamente.
E_INVALIDARG
 Uno o varios parámetros no se han proporcionado correctamente.

Requisitos

Requisito Value
Cliente mínimo compatible
 Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible
 Windows Server 2012 [solo aplicaciones de escritorio]
Encabezado
Ndattributils.h

Vea también

UtilStringCopyWithAlloc

UtilLoadStringWithAlloc

StringCchPrintf

MAKEINTRESOURCE

CoTaskMemFree