Função AcxObjectBagRetrieveI1 (acxmisc.h)

Importante

Algumas informações referem-se a um produto de pré-lançamento que pode ser substancialmente modificado antes de ser lançado comercialmente. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

A função AcxObjectBagRetrieveI1 recupera um valor DE BYTE (CHAR) I1 de um AcxObjectBag existente e intializado que contém valores.

Sintaxe

NTSTATUS AcxObjectBagRetrieveI1(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  CHAR             *Value
);

Parâmetros

ObjectBag

Um objeto ACX ObjectBag intializado. 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 a ser recuperado do ObjectBag.

Retornar valor

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

Comentários

Exemplo

Este exemplo mostra o uso de AcxObjectBagRetrieveI1.

    ACXOBJECTBAG objBag     = NULL;
    CHAR         i1Value    = 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, TestI1);

    i1Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddI1(objBag, &TestI1, i1Value)

    // Retrieve the value from the object bag
    i1Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveI1(objBag, &TestI1, &i1Value));

Requisitos do ACX

Versão mínima do ACX: 1.0

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

Requisitos

   
Cabeçalho acxmisc.h

Confira também