Функция PropVariantToInt16WithDefault (propvarutil.h)
Извлекает значение свойства Int16 структуры PROPVARIANT . Если значение в настоящее время не существует, возвращается указанное значение по умолчанию.
Синтаксис
PSSTDAPI_(SHORT) PropVariantToInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] SHORT iDefault
);
Параметры
[in] propvarIn
Тип: REFPROPVARIANT
Ссылка на исходную структуру PROPVARIANT .
[in] iDefault
Тип: SHORT
Задает значение свойства по умолчанию для использования, если значение в настоящее время не существует.
Возвращаемое значение
Тип: SHORT
Возвращает извлеченное короткое значение или значение по умолчанию.
Комментарии
Эта вспомогательская функция используется в тех местах, где вызывающее приложение ожидает , что PROPVARIANT будет содержать значение Int16 , и в противном случае хочет использовать значение по умолчанию. Например, приложение, получающее значения из хранилища свойств, может использовать его для безопасного извлечения значения SHORT для свойств Int16 .
Если исходный PROPVARIANT имеет тип VT_I2, эта вспомогательная функция извлекает значение Int16 . В противном случае он пытается преобразовать значение в структуре PROPVARIANT в SHORT. Если исходный PROPVARIANT имеет тип VT_EMPTY или преобразование невозможно, то PropVariantToInt16WithDefault вернет значение по умолчанию, предоставленное iDefault. Список возможных преобразований см. в разделе PropVariantChangeType .
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | 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 |