Функция AcxObjectBagRetrieveI2 (acxmisc.h)

  • Статья

Функция AcxObjectBagRetrieveI2 извлекает значение int two byte I2 (SHORT) из существующего инициализированного acxObjectBag, содержащего значения.

Синтаксис

NTSTATUS AcxObjectBagRetrieveI2(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  SHORT            *Value
);

Параметры

ObjectBag

Инициализированный объект ACX ObjectBag. Дополнительные сведения см. в разделе ACX — сводка по объектам ACX.

ValueName

Имя значения, которое будет использоваться для доступа к значению.

Value

Значение, извлекаемое из ObjectBag.

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

Возвращает значение STATUS_SUCCESS , если вызов был выполнен успешно. В противном случае возвращается соответствующий код ошибки. Дополнительные сведения см. в разделе Использование значений NTSTATUS.

Remarks

Пример

В этом примере показано использование AcxObjectBagRetrieveI2.

    ACXOBJECTBAG objBag     = NULL;
    SHORT        i2Value    = 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, TestI2);

    i2Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddI2(objBag, &TestI2, i2Value));

    // Retrieve the value from the object bag
    i2Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveI2(objBag, &TestI2, &i2Value));

Требования к ACX

Минимальная версия ACX: 1.0

Дополнительные сведения о версиях ACX см. в статье Обзор версий ACX.

Требования

Требование Значение
Заголовок acxmisc.h
IRQL PASSIVE_LEVEL

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