AcxObjectBagRetrieveI1 function (acxmisc.h)
The AcxObjectBagRetrieveI1 function retrieves an int one byte (CHAR) I1 value from an existing, initialized AcxObjectBag that contains values.
NTSTATUS AcxObjectBagRetrieveI1(
ACXOBJECTBAG ObjectBag,
PCUNICODE_STRING ValueName,
CHAR *Value
);
ObjectBag
An initialized ObjectBag ACX object. For more information, see ACX - Summary of ACX Objects.
ValueName
The name of the value that will be used to access the value.
Value
The Value to be retrieved from the ObjectBag.
Returns STATUS_SUCCESS
if the call was successful. Otherwise, it returns an appropriate error code. For more information, see Using NTSTATUS Values.
This example shows the use of 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));
Minimum ACX version: 1.0
For more information about ACX versions, see ACX version overview.
Requirement | Value |
---|---|
Header | acxmisc.h |
IRQL | PASSIVE_LEVEL |