AcxObjectBagRetrieveUI1, fonction (acxmisc.h)

  • Article

La fonction AcxObjectBagRetrieveUI1 récupère une valeur d’interface utilisateur1 d’un octet (UCHAR) non signée à partir d’un AcxObjectBag initialisé existant qui contient des valeurs.

Syntaxe

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

Paramètres

ObjectBag

Objet ACX ObjectBag initialisé. Pour plus d’informations, consultez ACX - Résumé des objets ACX.

ValueName

Nom de la valeur qui sera utilisée pour accéder à la valeur.

Value

Valeur UCHAR à récupérer à partir de ObjectBag.

Valeur retournée

Retourne STATUS_SUCCESS si l’appel a réussi. Sinon, il retourne un code d’erreur approprié. Pour plus d’informations, consultez Utilisation de valeurs NTSTATUS.

Remarques

Exemple

Cet exemple montre l’utilisation d’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));

Configuration requise d’ACX

Version minimale d’ACX : 1.0

Pour plus d’informations sur les versions d’ACX, consultez Vue d’ensemble des versions d’ACX.

Configuration requise

Condition requise Valeur
En-tête acxmisc.h

Voir aussi