AcxObjectBagRetrieveI1, fonction (acxmisc.h)

Important

Certaines informations concernent un produit prérelease qui peut être sensiblement modifié avant sa publication commerciale. Microsoft ne donne aucune garantie, expresse ou implicite, concernant les informations fournies ici.

La fonction AcxObjectBagRetrieveI1 récupère une valeur int one octet (CHAR) I1 à partir d’une valeur AcxObjectBag existante, intialisée qui contient des valeurs.

Syntaxe

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

Paramètres

ObjectBag

Objet OBJECTBag ACX intialisé. 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 à 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 des valeurs NTSTATUS.

Remarques

Exemple

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

Spécifications

   
En-tête acxmisc.h

Voir aussi