UtilAssembleStringsWithAlloc 関数
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 で終わる。
Note
このパラメーターを 0 に設定することはできません。
-
InputFormat [in]
-
種類: LPCWSTR
StringCchPrintf に渡される書式パラメーターを表す文字列テーブルの文字列リソース。 MAKEINTRESOURCE を使用して構築されます。
リソース文字列形式では、ワイド文字列を受け取る書式パラメーター、または符号なし long およびワイド文字列を受け取る書式パラメーターを指定する必要があります。
-
InputString [in]
-
種類: LPCWSTR
format パラメーターのワイド文字列の代わりに StringCchPrintf に渡される引数を表す文字列テーブルの文字列リソース。 MAKEINTRESOURCE を使用して構築されます。
-
AdditionalArgument [in]
-
型: BOOLEAN
True を指定すると 、AdditionalValue を最初の書式指定引数として StringCchPrintf に渡す必要があります。それ以外の場合は false ( および InputString によって識別されるリソース文字列のみが渡されます)。
-
AdditionalValue [in]
-
種類: ULONG
AdditionalArgument が true の場合に StringCchPrintf に最初の書式設定引数として渡す値。
戻り値
種類: HRESULT
可能な戻り値には、次のものが含まれますが、これらに限定されません。
| リターン コード | 説明 |
|---|---|
|
操作が成功しました。 |
|
1 つ以上のパラメーターが正しく指定されていません。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 8 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2012 [デスクトップ アプリのみ] |
| Header |
|