AcxObjectBagAddUI1-Funktion (acxmisc.h)

  • Artikel

Die AcxObjectBagAddUI1-Funktion fügt einem vorhandenen, initialisierten AcxObjectBag einen unsigned int one byte (UCHAR) I1-Wert hinzu.

Syntax

NTSTATUS AcxObjectBagAddUI1(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  UCHAR            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 dem ObjectBag hinzugefügt werden soll.

Rückgabewert

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

Bemerkungen

Beispiel

Dieses Beispiel zeigt die Verwendung von AcxObjectBagAddUI1.

    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-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