Функция AcxObjectBagRetrieveUI2 (acxmisc.h)
Функция AcxObjectBagRetrieveUI2 извлекает неподписанный int two byte UI2 (USHORT) из существующего инициализированного AcxObjectBag, содержащего значения.
Синтаксис
NTSTATUS AcxObjectBagRetrieveUI2(
ACXOBJECTBAG ObjectBag,
PCUNICODE_STRING ValueName,
USHORT *Value
);
Параметры
ObjectBag
Инициализированный объект ObjectBag ACX. Дополнительные сведения см. в разделе ACX — сводка по объектам ACX.
ValueName
Имя значения, которое будет использоваться для доступа к значению.
Value
Значение, извлекаемое из ObjectBag.
Возвращаемое значение
Возвращает значение STATUS_SUCCESS , если вызов был успешным. В противном случае возвращается соответствующий код ошибки. Дополнительные сведения см. в разделе Использование значений NTSTATUS.
Remarks
Пример
В этом примере показано использование AcxObjectBagRetrieveUI2.
ACXOBJECTBAG objBag = NULL;
USHORT ui2Value = 0;
//Initialize an object bag configuration
ACX_OBJECTBAG_CONFIG objBagCfg;
ACX_OBJECTBAG_CONFIG_INIT(&objBagCfg);
// Set the WDF attributes, and create an object bag
WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
attributes.ParentObject = Circuit;
RETURN_NTSTATUS_IF_FAILED(AcxObjectBagCreate(&attributes, &objBagCfg, &objBag));
// Enable deletion of the object bag when the function completes and goes out of scope
auto objBag_scope = scope_exit([&objBag]() {
if (objBag != NULL)
{
WdfObjectDelete(objBag);
}
});
//Create Properties and add them to an object bag
DECLARE_CONST_ACXOBJECTBAG_DRIVER_PROPERTY_NAME(VendorX, TestUI2);
ui2Value = 0x55;
RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddUI2(objBag, &TestUI2, ui2Value));
// Retrieve the value from the object bag
ui2Value = 0;
RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveUI2(objBag, &TestUI2, &ui2Value));
Требования ACX
Минимальная версия ACX: 1.0
Дополнительные сведения о версиях ACX см. в статье Обзор версий ACX.
Требования
| Требование | Значение |
|---|---|
| Заголовок | acxmisc.h |
| IRQL | PASSIVE_LEVEL |