acxObjectBagRetrieveUI1 函式 (acxmisc.h)

  • 發行項

AcxObjectBagRetrieveUI1 函式會從包含值的現有初始化 AcxObjectBag 擷取未簽署的一個字節 (UCHAR) UI1 值。

語法

NTSTATUS AcxObjectBagRetrieveUI1(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  UCHAR            *Value
);

參數

ObjectBag

初始化的 ObjectBag ACX 物件。 如需詳細資訊，請參閱 ACX - ACX 物件的摘要。

ValueName

將用來存取值的值名稱。

Value

要從 ObjectBag 擷取的 UCHAR 值。

傳回值

如果呼叫成功，則傳 STATUS_SUCCESS 回 。 否則，它會傳回適當的錯誤碼。 如需詳細資訊，請參閱 使用NTSTATUS值。

備註

範例

此範例顯示 AcxObjectBagRetrieveUI1 的使用。

    ACXOBJECTBAG objBag     = NULL;
    UCHAR        ui1Value   = 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, TestUI1);

    ui1Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddUI1(objBag, &TestUI1, ui1Value));

    // Retrieve the value from the object bag
    ui1Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveUI1(objBag, &TestUI1, &ui1Value));

ACX 需求

最小 ACX 版本： 1.0

如需 ACX 版本的詳細資訊，請參閱 ACX 版本概觀。

規格需求

需求 值
標頭 acxmisc.h

另請參閱