AcxObjectBagRetrieveUI2-Funktion (acxmisc.h)

Die AcxObjectBagRetrieveUI2-Funktion ruft ein nicht signiertes int zwei Byte UI2 (USHORT) aus einem vorhandenen, initialisierten AcxObjectBag ab, das Werte enthält.

Syntax

NTSTATUS AcxObjectBagRetrieveUI2(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  USHORT           *Value
);

Parameter

ObjectBag

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

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 STATUS_SUCCESS zurück, wenn der Anruf erfolgreich war. Andernfalls wird ein entsprechender Fehlercode zurückgegeben. Weitere Informationen finden Sie unter Verwenden von NTSTATUS-Werten.

Bemerkungen

Beispiel

Dieses Beispiel zeigt die Verwendung von 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-Anforderungen

Mindestens ACX-Version: 1.0

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

Anforderungen

Siehe auch

• acxmisc.h-Header