Fungsi UtilAssembleStringsWithAlloc

Artikel
06/13/2023

Fungsi UtilAssembleStringsWithAlloc mengalokasikan string dan memformatnya menggunakan string yang disediakan oleh tabel string. Fungsi ini menggunakan StringCchPrintf untuk membuat string yang diformat.

Sintaks

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

Parameter

Buffer [out]

Jenis: LPWSTR*

Lokasi tempat string yang baru dialokasikan akan ditempatkan. Ketika string tidak lagi diperlukan, string harus dirilis dengan CoTaskMemFree.

BufferMax [in]

Jenis: UINT

Jumlah maksimum karakter yang diizinkan dalam string yang dialokasikan oleh Buffer. Jika string berformat yang dihasilkan lebih panjang dari jumlah karakter yang ditentukan, string tersebut dipotong dan dihentikan null.

Catatan

Parameter ini mungkin tidak diatur ke nol.

InputFormat [in]

Jenis: LPCWSTR

Sumber daya string dari tabel string yang mewakili parameter format yang diteruskan ke StringCchPrintf. Ini dibangun menggunakan MAKEINTRESOURCE.

Format string sumber daya harus menentukan parameter format yang mengambil string lebar, atau parameter format yang mengambil string panjang dan lebar yang tidak ditandatangani.

InputString [in]

Jenis: LPCWSTR

Sumber daya string dari tabel string yang mewakili argumen yang diteruskan ke StringCchPrintf sebagai pengganti string lebar dalam parameter format. Ini dibangun menggunakan MAKEINTRESOURCE.

AdditionalArgument [in]

Jenis: BOOLEAN

True jika AdditionalValue harus diteruskan sebagai argumen pemformatan pertama ke StringCchPrintf; jika tidak, false (dan hanya string sumber daya yang diidentifikasi oleh InputString yang akan diteruskan).

AdditionalValue [in]

Jenis: ULONG

Nilai yang akan diteruskan sebagai argumen pemformatan pertama ke StringCchPrintf jika AdditionalArgument benar.

Nilai kembali

Jenis: HRESULT

Nilai yang mungkin dikembalikan termasuk, tetapi tidak terbatas pada, berikut ini.

Menampilkan kode	Deskripsi
S_OK	Operasi berhasil.
E_INVALIDARG	Satu atau beberapa parameter belum disediakan dengan benar.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8 [khusus aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Header	Ndattributils.h

Lihat juga

UtilStringCopyWithAlloc
UtilLoadStringWithAlloc
StringCchPrintf
MAKEINTRESOURCE
CoTaskMemFree

Bagikan melalui