AcxObjectBagAddGuid-Funktion (acxmisc.h)

  • Artikel

Die AcxObjectBagAddGuid-Funktion fügt guid-Daten zu einem vorhandenen, initialisierten AcxObjectBag hinzu.

Syntax

NTSTATUS AcxObjectBagAddGuid(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  GUID             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 entsprechender Fehlercode zurückgegeben. Weitere Informationen finden Sie unter Verwenden von NTSTATUS-Werten.

Bemerkungen

Beispiel

Der folgende Code zeigt die Verwendung von AcxObjectBagAddGuid.

    // Object bag
    //
    // This obj-bag config setting is shared by all composite/circuit templates.
    ACX_OBJECTBAG_CONFIG objBagCfg;
    ACX_OBJECTBAG_CONFIG_INIT(&objBagCfg);

    WDF_OBJECT_ATTRIBUTES attributes;
    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
    attributes.ParentObject = AcxGetManager(NULL);

    ACXOBJECTBAG objBag = NULL;
    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);
        }
    });

    //
    // Add a test unsigned int 4 bytes to the object bag
    //
    RETURN_NTSTATUS_IF_FAILED(ObjBagAddTestUI4(objBag, 0));

    //
    // Add unique circuit ID to the object bag
    // This unique Id will be picked up by DSP circuit
    //
    DECLARE_CONST_ACXOBJECTBAG_SYSTEM_PROPERTY_NAME(UniqueID);
    GUID uniqueID = { 0 };
    RETURN_NTSTATUS_IF_FAILED(RtlGUIDFromString(&circuit_IDs[compositeType], &uniqueID));

    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddGuid(objBag, &UniqueID, uniqueID));

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