Функция PropVariantClear (combaseapi.h)

Функция PropVariantClear освобождает все элементы, которые могут быть освобождены в заданной структуре PROPVARIANT . Для сложных элементов с известными указателями элементов базовые элементы освобождаются перед освобождением содержащего элемента.

Синтаксис

HRESULT PropVariantClear(
  [in] PROPVARIANT *pvar
);

Параметры

[in] pvar

Указатель на инициализированную структуру PROPVARIANT , для которой должны быть освобождены все освобожденные элементы. При возврате все нули записываются в структуру PROPVARIANT .

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

Эта функция возвращает HRESULT.

Комментарии

На любом уровне косвенного обращения указатели NULL игнорируются. Например, параметр pvar указывает на структуру PROPVARIANT типа VT_CF. Элемент pclipdata структуры PROPVARIANT указывает на структуру CLIPDATA . Указатель pClipData в структуре CLIPDATA имеет значение NULL. В этом примере указатель pClipData игнорируется. Однако структура CLIPDATA , на которую указывает элемент pclipdata структуры PROPVARIANT , освобождается.

При возврате эта функция записывает нули в указанную структуру PROPVARIANT , поэтому тип VT VT_EMPTY.

Передача NULL в качестве параметра pvar приводит к получению кода возврата S_OK.

Примечание Не используйте эту функцию для инициализации структур PROPVARIANT . Вместо этого инициализируйте эти структуры с помощью макроса PropVariantInit (определенного в Propidl.h).

 

Требования

Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения | Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения | Приложения UWP]
Целевая платформа	Windows
Header	combaseapi.h
Библиотека	Ole32.lib
DLL	Ole32.dll

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

FreePropVariantArray