UID | tech.root | title | ms.date | targetos | description | prerelease | req.assembly | req.construct-type | req.ddi-compliance | req.dll | req.header | req.idl | req.include-header | req.irql | req.kmdf-ver | req.lib | req.max-support | req.namespace | req.redist | req.target-min-winverclnt | req.target-min-winversvr | req.target-type | req.type-library | req.umdf-ver | req.unicode-ansi | topic_type | api_type | api_location | api_name | f1_keywords | dev_langs | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:acxmisc.AcxObjectBagAddUI1 |
audio |
AcxObjectBagAddUI1 |
12/16/2022 |
Windows |
The AcxObjectBagAddUI1 function adds an unsigned int one byte (UCHAR) I1 value to an existing, initialized AcxObjectBag. |
false |
function |
acxmisc.h |
PASSIVE_LEVEL |
|
|
|
|
|
|
The AcxObjectBagAddUI1 function adds an unsigned int one byte (UCHAR) I1 value to an existing, initialized AcxObjectBag.
An initialized ObjectBag ACX object. For more information, see ACX - Summary of ACX Objects.
The name of the value that will be used to access the value.
The Value to be added to 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 AcxObjectBagAddUI1.
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));
Minimum ACX version: 1.0
For more information about ACX versions, see ACX version overview.