Fonction WindowsCreateString (winstring.h)

  • Article

Crée un HSTRING basé sur la chaîne source spécifiée.

Syntaxe

HRESULT WindowsCreateString(
  PCNZWCH sourceString,
  UINT32  length,
  HSTRING *string
);

Paramètres

sourceString

Type : [in, facultatif] LPCWSTR

Chaîne terminée par null à utiliser comme source pour le nouveau HSTRING. Pour créer une chaîne vide ou NULL , passez NULL pour sourceString et 0 pour la longueur.

length

Type : [in] UINT32

Longueur de sourceString, en caractères Unicode. Doit être 0 si sourceString a la valeur NULL.

string

Type : [out] HSTRING*

Pointeur vers le HSTRING nouvellement créé, ou NULL si une erreur se produit. Tout contenu existant dans la chaîne est remplacé. Le HSTRING est un type de handle standard.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour Description
S_OK
 Le HSTRING a été créé avec succès.
E_INVALIDARG
 chaîne a la valeur NULL.
E_OUTOFMEMORY
 Échec de l’allocation du nouveau HSTRING.
E_POINTER
 sourceString a la valeur NULL et la longueur est différente de zéro.

Remarques

Utilisez la fonction WindowsCreateString pour allouer un nouveau HSTRING. Le Windows Runtime copie la chaîne dans la mémoire tampon de stockage du nouveau HSTRING et gère la durée de vie de la mémoire tampon à l’aide d’un nombre de références. Appelez la fonction WindowsCreateStringReference pour créer une chaîne de passe rapide, qui utilise une chaîne existante sans la copier.

Appelez la fonction WindowsDeleteString pour désallouer le HSTRING. Chaque appel à la fonction WindowsCreateString doit être mis en correspondance par un appel à WindowsDeleteString.

Pour créer une chaîne vide ou NULL , passez NULL pour sourceString et 0 pour la longueur.

Si sourceString contient des caractères Null incorporés, la fonction WindowsCreateString copie tous les caractères dans le caractère null de fin.

Configuration requise

   
Client minimal pris en charge Windows 8 [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2012 [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête winstring.h

Voir aussi

WindowsCreateStringReference

WindowsDeleteString