Функция WindowsDeleteStringBuffer (winstring.h)

Удаляет предварительно настроенный строковый буфер, если он не был повышен до HSTRING.

Синтаксис

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

Параметры

bufferHandle

Тип: [in] HSTRING_BUFFER

Буфер, который требуется удалить. Функция WindowsDeleteStringBuffer создает исключение, если bufferHandle не был выделен вызовом функции WindowsPreallocateStringBuffer .

Возвращаемое значение

Тип: HRESULT

Эта функция может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Буфер успешно удален.
E_POINTER	bufferHandle имеет значение NULL.

Комментарии

Используйте функцию WindowsDeleteStringBuffer , чтобы отменить буфер строки, созданный функцией WindowsPreallocateStringBuffer , но не повышен до HSTRING функцией WindowsPromoteStringBuffer .

Примечание Вызов WindowsPromoteStringBuffer после вызова WindowsDeleteStringBuffer с тем же дескриптором буфера не определен.

 

Примеры

В следующем примере кода показано, как использовать функцию 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);
}

Требования

Требование	Значение
Минимальная версия клиента	Windows 8 [классические приложения | Приложения UWP]
Минимальная версия сервера	Windows Server 2012 [классические приложения | Приложения UWP]
Целевая платформа	Windows
Header	winstring.h
Библиотека	RuntimeObject.lib
DLL	ComBase.dll

См. также раздел

HSTRING

HSTRING_BUFFER

WindowsPreallocateStringBuffer

WindowsPromoteStringBuffer