UtilAssembleStringsWithAlloc-Funktion
Die UtilAssembleStringsWithAlloc-Funktion ordnet eine Zeichenfolge zu und formatiert sie mithilfe von Zeichenfolgen, die von der Zeichenfolgentabelle bereitgestellt werden. Diese Funktion verwendet StringCchPrintf, um die formatierte Zeichenfolge zu erstellen.
Syntax
HRESULT UtilAssembleStringsWithAlloc(
_Out_ LPWSTR *Buffer,
_In_ UINT BufferMax,
_In_ LPCWSTR InputFormat,
_In_ LPCWSTR InputString,
_In_ BOOLEAN AdditionalArgument,
_In_ ULONG AdditionalValue
);
Parameter
-
Puffer [ out]
-
Typ: LPWSTR *
Der Speicherort, an dem die neu zugeordnete Zeichenfolge platziert wird. Wenn die Zeichenfolge nicht mehr benötigt wird, muss sie mit CoTaskMemFreefreigegeben werden.
-
BufferMax [ In]
-
Typ: UINT
Die maximale Anzahl von Zeichen, die in der von Buffer zugeordneten Zeichenfolge zulässig sind. Wenn die resultierende formatierte Zeichenfolge länger als die angegebene Anzahl von Zeichen ist, wird sie abgeschnitten und mit NULL beendet.
Hinweis
Dieser Parameter kann nicht auf 0 (null) festgelegt werden.
-
InputFormat [ In]
-
Typ: LPCWSTR
Zeichenfolgenressource aus der Zeichenfolgentabelle, die einen format-Parameter darstellt, der an StringCchPrintfübergeben wird. Sie wird mit MAKEINTRESOURCEerstellt.
Das Format der Ressourcenzeichenfolge muss entweder einen Formatparameter angeben, der eine breite Zeichenfolge annimmt, oder einen Formatparameter, der eine lange und eine breite Zeichenfolge ohne Vorzeichen annimmt.
-
InputString [ In]
-
Typ: LPCWSTR
Zeichenfolgenressource aus der Zeichenfolgentabelle, die ein Argument darstellt, das anstelle der breiten Zeichenfolge im Formatparameter an StringCchPrintf übergeben wird. Sie wird mit MAKEINTRESOURCEerstellt.
-
AdditionalArgument [ In]
-
Typ: BOOLEAN
TRUE, wenn AdditionalValue als erstes Formatierungsargument an StringCchPrintfübergeben werden soll; Andernfalls FALSE (und nur die durch InputString identifizierte Ressourcenzeichenfolge wird übergeben).
-
AdditionalValue [ In]
-
Typ: ULONG
Der Wert, der als erstes Formatierungsargument an StringCchPrintf übergeben werden soll, wenn AdditionalArgument true ist.
Rückgabewert
Typ: HRESULT
Mögliche Rückgabewerte sind u. a. folgende.
| Rückgabecode | Beschreibung |
|---|---|
|
Der Vorgang wurde erfolgreich ausgeführt. |
|
Mindestens ein Parameter wurde nicht ordnungsgemäß bereitgestellt. |
Requirements (Anforderungen)
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
[Windows 8 Nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
[Windows Server 2012 Nur Desktop-Apps] |
| Header |
|