Compartir a través de

Función AcxObjectBagRetrieveUI1 (acxmisc.h)

  • Artículo

La función AcxObjectBagRetrieveUI1 recupera un valor ui1 de un byte (UCHAR) sin signo de un valor AcxObjectBag inicializado existente que contiene valores.

Sintaxis

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

Parámetros

ObjectBag

Objeto ACX inicializado ObjectBag. Para obtener más información, vea ACX : resumen de objetos ACX.

ValueName

Nombre del valor que se usará para tener acceso al valor.

Value

Valor UCHAR que se va a recuperar de ObjectBag.

Valor devuelto

Devuelve STATUS_SUCCESS si la llamada se realizó correctamente. De lo contrario, devuelve un código de error adecuado. Para obtener más información, vea Uso de valores NTSTATUS.

Comentarios

Ejemplo

En este ejemplo se muestra el uso de 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));

Requisitos de ACX

Versión mínima de ACX: 1.0

Para obtener más información sobre las versiones de ACX, consulte Introducción a la versión de ACX.

Requisitos

Requisito Valor
Header acxmisc.h

Consulte también