Partilhar via

Função AcxObjectBagRetrieveUI1 (acxmisc.h)

  • Artigo

A função AcxObjectBagRetrieveUI1 recupera um valor UI1 de um byte (UCHAR) não assinado de um AcxObjectBag inicializado existente que contém valores.

Sintaxe

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

Parâmetros

ObjectBag

Um objeto ACX ObjectBag inicializado. Para obter mais informações, consulte ACX – Resumo de objetos ACX.

ValueName

O nome do valor que será usado para acessar o valor.

Value

O valor UCHAR a ser recuperado do ObjectBag.

Retornar valor

Retorna STATUS_SUCCESS se a chamada foi bem-sucedida. Caso contrário, ele retornará um código de erro apropriado. Para obter mais informações, consulte Usando valores NTSTATUS.

Comentários

Exemplo

Este exemplo mostra o 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 do ACX

Versão mínima do ACX: 1.0

Para obter mais informações sobre as versões do ACX, consulte Visão geral da versão do ACX.

Requisitos

Requisito Valor
Cabeçalho acxmisc.h

Confira também