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 CoTaskMemFree freigegeben werden.
-
BufferMax [in]
-
Typ: UINT
Die maximale Anzahl von Zeichen, die in der vom Puffer zugeordneten Zeichenfolge zulässig sind. Wenn die resultierende formatierte Zeichenfolge länger als die angegebene Anzahl von Zeichen ist, wird sie abgeschnitten und NULL-beendet.
Hinweis
Dieser Parameter darf nicht auf 0 (null) festgelegt werden.
-
InputFormat [in]
-
Typ: LPCWSTR
Zeichenfolgenressource aus der Zeichenfolgentabelle, die einen an StringCchPrintf übergebenen Formatparameter darstellt. Sie wird mit MAKEINTRESOURCE erstellt.
Das Ressourcenzeichenfolgenformat muss entweder einen Formatparameter angeben, der eine breite Zeichenfolge verwendet, oder einen Formatparameter, der eine lange und eine breite Zeichenfolge ohne Vorzeichen verwendet.
-
InputString [in]
-
Typ: LPCWSTR
Zeichenfolgenressource aus der Zeichenfolgentabelle, die ein Argument darstellt, das anstelle der breiten Zeichenfolge im format-Parameter an StringCchPrintf übergeben wird. Sie wird mit MAKEINTRESOURCE erstellt.
-
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. die folgenden:
| Rückgabecode | BESCHREIBUNG |
|---|---|
|
Der Vorgang wurde erfolgreich ausgeführt. |
|
Mindestens ein Parameter wurde nicht ordnungsgemäß bereitgestellt. |
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Windows 8 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
Windows Server 2012 [nur Desktop-Apps] |
| Header |
|