Функция PropVariantToBSTR (propvarutil.h)

Статья
03/01/2024

Извлекает значение свойства BSTR структуры PROPVARIANT .

Синтаксис

PSSTDAPI PropVariantToBSTR(
  [in]  REFPROPVARIANT propvar,
  [out] BSTR           *pbstrOut
);

Параметры

[in] propvar

Тип: REFPROPVARIANT

Ссылка на исходную структуру PROPVARIANT .

[out] pbstrOut

Тип: BSTR*

Указатель на извлеченное значение свойства, если оно существует; в противном случае содержит пустую строку.

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

Тип: HRESULT

Если эта функция завершается успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Если исходный PROPVARIANT имеет тип VT_BSTR или VT_LPWSTR, эта функция извлекает строку в виде значения BSTR . В противном случае он пытается преобразовать значение в структуре PROPVARIANT в строку. Если преобразование невозможно, PropVariantToBSTR возвращает код сбоя и устанавливает для pbstrOutзначение NULL. Список возможных преобразований см. в разделе PropVariantChangeType .

VT_EMPTY успешно преобразуется в выделенную BSTR, содержащую "".

Вызывающее приложение отвечает за использование SysFreeString , чтобы освободить BSTR , на который указывает pbstrOut , когда он больше не нужен.

В дополнение к преобразованиям, предоставляемым PropVariantChangeType, следующие особые случаи применяются к PropVariantToBSTR.

PROPVARIANT с векторным значением преобразуются в строки путем разделения каждого элемента с помощью "; ". Например, PropVariantToBSTR преобразует вектор из 3 целых чисел {3, 1, 4} в строку "3; 1; 4". Точка с запятой не зависит от текущего языкового стандарта.
VT_BLOB, VT_STREAM, VT_STREAMED_OBJECT и VT_UNKNOWN значения преобразуются в строки с помощью неподдерживаемой кодировки. Невозможно декодировать строки, созданные таким образом, и формат может измениться в будущем.

Примеры

В следующем примере, который будет включен в состав более крупной программы, показано, как использовать PropVariantToBSTR для доступа к строковом значению в PROPVARIANT.

// IPropertyStore *ppropstore;
// Assume the variable ppropstore is initialized and valid.
PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Title, &propvar);

if (SUCCEEDED(hr))
{
    // PKEY_Title is expected to produce a VT_LPWSTR or VT_EMPTY value.
    // PropVariantToBSTR will convert VT_EMPTY to "".
    BSTR bstrTitle;
    
    hr = PropVariantToBSTR(propvar, &bstrTitle);
    
    if (SUCCEEDED(hr))
    {
        // bstrTitle is now valid.
    }
    else
    {
        // bstrTitle is always NULL.
    }
    PropVariantClear(&propvar);
}

Требования

Требование	Значение
Минимальная версия клиента	Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения]
Целевая платформа	Windows
Header	propvarutil.h
Библиотека	Propsys.lib
DLL	Propsys.dll (версия 6.0 или более поздняя)
Распространяемые компоненты	Windows Desktop Search (WDS) 3.0