Fonction WindowsDeleteStringBuffer (winstring.h)

Article
03/13/2024

Ignore une mémoire tampon de chaîne préallouée si elle n’a pas été promue en HSTRING.

Syntaxe

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

Paramètres

bufferHandle

Type : [in] HSTRING_BUFFER

Mémoire tampon à ignorer. La fonction WindowsDeleteStringBuffer lève une exception si bufferHandle n’a pas été alloué par un appel à la fonction WindowsPreallocateStringBuffer .

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	La mémoire tampon a été ignorée.
E_POINTER	bufferHandle a lavaleur NULL.

Remarques

Utilisez la fonction WindowsDeleteStringBuffer pour ignorer une mémoire tampon de chaîne qui a été créée par la fonction WindowsPreallocateStringBuffer mais qui n’a pas été promue en HSTRING par la fonction WindowsPromoteStringBuffer .

Note L’appel de WindowsPromoteStringBuffer après avoir appelé WindowsDeleteStringBuffer avec le même handle de mémoire tampon n’est pas défini.

Exemples

L’exemple de code suivant montre comment utiliser la fonction WindowsDeleteStringBuffer .

int main()
{
    HSTRING_BUFFER hStringBuffer = NULL;
    PWSTR strBuffer = NULL;
    HRESULT hr = WindowsPreallocateStringBuffer(10, &strBuffer, &hStringBuffer);

    // You hit a case in which you need to discard the buffer.

    WindowsStringDeleteBuffer(hStringBuffer);
}

Configuration requise

Condition requise	Valeur
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
Bibliothèque	RuntimeObject.lib
DLL	ComBase.dll

Voir aussi

HSTRING

HSTRING_BUFFER

WindowsPreallocateStringBuffer

WindowsPromoteStringBuffer

Partager via