Fonction UtilAssembleStringsWithAlloc

Article
06/13/2023

La fonction UtilAssembleStringsWithAlloc alloue une chaîne et la met en forme à l’aide de chaînes fournies par la table de chaînes. Cette fonction utilise StringCchPrintf pour créer la chaîne mise en forme.

Syntaxe

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

Paramètres

Mémoire tampon [out]

Type : LPWSTR*

Emplacement où la chaîne nouvellement allouée sera placée. Lorsque la chaîne n’est plus nécessaire, elle doit être publiée avec CoTaskMemFree.

BufferMax [in]

Type : UINT

Nombre maximal de caractères autorisés dans la chaîne allouée par Buffer. Si la chaîne mise en forme résultante est plus longue que le nombre de caractères spécifié, elle est tronquée et terminée par null.

Notes

Ce paramètre peut ne pas être défini sur zéro.

InputFormat [in]

Type : LPCWSTR

Ressource string de la table de chaînes représentant un paramètre de format passé à StringCchPrintf. Il est construit à l’aide de MAKEINTRESOURCE.

Le format de chaîne de ressources doit spécifier un paramètre de format prenant une chaîne large, ou un paramètre de format prenant une chaîne longue et une chaîne large non signée.

InputString [in]

Type : LPCWSTR

Ressource string de la table de chaînes représentant un argument passé à StringCchPrintf à la place de la chaîne large dans le paramètre de format. Il est construit à l’aide de MAKEINTRESOURCE.

AdditionalArgument [in]

Type : BOOLEAN

True si AdditionalValue doit être passé comme premier argument de mise en forme à StringCchPrintf ; sinon, false (et seule la chaîne de ressource identifiée par InputString sera transmise).

AdditionalValue [in]

Type : ULONG

Valeur à passer comme premier argument de mise en forme à StringCchPrintf si AdditionalArgument a la valeur true.

Valeur retournée

Type : HRESULT

Les valeurs de retour possibles incluent, sans s’y limiter, les éléments suivants.

Code de retour	Description
S_OK	L’opération a réussi.
E_INVALIDARG	Un ou plusieurs paramètres n’ont pas été fournis correctement.

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
En-tête	Ndattributils.h

Voir aussi

UtilStringCopyWithAlloc
UtilLoadStringWithAlloc
StringCchPrintf
MAKEINTRESOURCE
CoTaskMemFree

Partager via