Функция VariantToBooleanWithDefault (propvarutil.h)
Извлекает значение BOOL из структуры VARIANT . Если значение не существует, возвращается указанное значение по умолчанию.
Синтаксис
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
Параметры
[in] varIn
Тип: REFVARIANT
Ссылка на исходную структуру VARIANT .
[in] fDefault
Тип: BOOL
Значение по умолчанию для использования, если извлекаемое значение не существует.
Возвращаемое значение
Тип: BOOL
Возвращает извлеченное значение BOOL ; в противном случае — значение по умолчанию, указанное в fDefault.
Комментарии
Эта вспомогательная функция используется, когда вызывающее приложение ожидает , что VARIANT будет содержать значение BOOL , и хочет использовать значение по умолчанию, если это не так.
Если исходный variant имеет тип VT_BOOL, этот вспомогательный метод извлекает значение BOOL .
Если исходный variant не имеет типа VT_BOOL, функция пытается преобразовать значение в VARIANT в boOL.
Если исходный variant имеет тип VT_EMPTY или преобразование невозможно, VariantToBooleanWithDefault возвращает значение по умолчанию, предоставленное fDefault. Список возможных преобразований см. в разделе PropVariantChangeType .
Примеры
В следующем примере, который будет включен в более крупную программу, показано, как использовать VariantToBooleanWithDefault для доступа к значению BOOL , хранящейся в структуре VARIANT .
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.
BOOL fValue = VariantToBooleanWithDefault(var, FALSE);
// fValue is now valid.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | 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 |