Partager via


WindowsCreateString, fonction (winstring.h)

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, optional] LPCWSTR

Mémoire tampon de texte encodée en UTF-16LE à utiliser comme source pour le nouveau HSTRING. Pour créer une chaîne null, vide ou vide , passez NULL pour sourceString et 0 pour la longueur.

Cette mémoire tampon n’est pas nécessaire pour être terminée par null. WindowsCreateString copie son contenu et ajoute un terminateur Null dans la nouvelle mémoire tampon qui sauvegarde le HSTRING retourné.

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é. HSTRING est un type de handle standard.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

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

Remarques

Utilisez la fonction WindowsCreateString pour allouer un nouveau HSTRING. Windows Runtime copie la chaîne vers 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 pass rapide, qui utilise une chaîne existante sans la copier.

Appelez la fonction WindowsDeleteString pour annuler l’allocation du HSTRING. Chaque appel à la fonction WindowsCreateString doit être mis en correspondance par un appel à WindowsDeleteString.

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

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

Spécifications

Requirement Valeur
Client minimum requis Windows 8 [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2012 [applications de bureau | Applications UWP]
plateforme cible Fenêtres
Header winstring.h
Library mincore.lib

Voir aussi

WindowsCreateStringReference

WindowsDeleteString