AcxObjectBagRetrieveUI4-Funktion (acxmisc.h)

  • Artikel

Die AcxObjectBagRetrieveUI4-Funktion ruft einen unsigned int vier Byte UI4 -Wert (ULONG) aus einem vorhandenen, initialisierten AcxObjectBag-Wert ab, der Werte enthält.

Syntax

NTSTATUS AcxObjectBagRetrieveUI4(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  ULONG            *Value
);

Parameter

ObjectBag

Ein initialisiertes ObjectBag ACX-Objekt. Weitere Informationen finden Sie unter ACX – Zusammenfassung von ACX-Objekten.

ValueName

Der Name des Werts, der für den Zugriff auf den Wert verwendet wird.

Value

Der Wert, der aus dem ObjectBag abgerufen werden soll.

Rückgabewert

Gibt zurück STATUS_SUCCESS , wenn der Aufruf erfolgreich war. Andernfalls wird ein entsprechender Fehlercode zurückgegeben. Weitere Informationen finden Sie unter Verwenden von NTSTATUS-Werten.

Bemerkungen

Beispiel

In diesem Beispiel wird die Verwendung von AcxObjectBagRetrieveUI4 veranschaulicht.

    ACXOBJECTBAG objBag     = NULL;
    ULONG        ui4Value   = 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, TestUI4);

    ui4Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddUI4(objBag, &TestUI4, ui4Value));

    // Retrieve the value from the object bag
    ui4Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveUI4(objBag, &TestUI4, &ui4Value));

ACX-Anforderungen

AcX-Mindestversion: 1.0

Weitere Informationen zu ACX-Versionen finden Sie unter ACX-Versionsübersicht.

Anforderungen

Anforderung Wert
Header acxmisc.h
IRQL PASSIVE_LEVEL

Weitere Informationen