Função WindowsDeleteStringBuffer (winstring.h)

Artigo
03/04/2024

Descartará um buffer de cadeia de caracteres preallocado se ele não tiver sido promovido a um HSTRING.

Sintaxe

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

Parâmetros

bufferHandle

Tipo: [in] HSTRING_BUFFER

O buffer a ser descartado. A função WindowsDeleteStringBuffer gerará uma exceção se bufferHandle não tiver sido alocado por uma chamada para a função WindowsPreallocateStringBuffer .

Retornar valor

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno	Descrição
S_OK	O buffer foi descartado com êxito.
E_POINTER	bufferHandle é NULL.

Comentários

Use a função WindowsDeleteStringBuffer para descartar um buffer de cadeia de caracteres que foi criado pela função WindowsPreallocateStringBuffer , mas não foi promovido a um HSTRING pela função WindowsPromoteStringBuffer .

Nota Chamar WindowsPromoteStringBuffer depois de chamar WindowsDeleteStringBuffer com o mesmo identificador de buffer é indefinido.

Exemplos

O exemplo de código a seguir demonstra como usar a função 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);
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2012 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	winstring.h
Biblioteca	RuntimeObject.lib
DLL	ComBase.dll