AcxObjectBagRetrieveUnicodeString function (acxmisc.h)

Article
02/22/2024

The AcxObjectBagRetrieveUnicodeString function retrieves a unicode string value from an existing, initialized AcxObjectBag that contains values.

Syntax

NTSTATUS AcxObjectBagRetrieveUnicodeString(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  PUNICODE_STRING  Value
);

Parameters

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.

Return value

Returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code. For more information, see Using NTSTATUS Values.

Remarks

Example

This example shows the use of AcxObjectBagRetrieveUnicodeString.

        UNICODE_STRING          unicodeStringValue;
        ACX_OBJECTBAG_CONFIG    objBagCfg;

        DECLARE_CONST_ACXOBJECTBAG_SYSTEM_PROPERTY_NAME(testName);

        ACX_OBJECTBAG_CONFIG_INIT(&objBagCfg);
        objBagCfg.Handle = CircuitConfig->CompositeProperties;
        objBagCfg.Flags |= AcxObjectBagConfigOpenWithHandle;

        WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
        ACXOBJECTBAG objBag = NULL;

        RETURN_NTSTATUS_IF_FAILED(AcxObjectBagOpen(&attributes, &objBagCfg, &objBag));
        auto objBag_free = scope_exit([&objBag]() {
            WdfObjectDelete(objBag);
            });

        RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveUnicodeString(objBag, &testName, &unicodeStringValue));

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

Requirements

Requirement	Value
Header	acxmisc.h
IRQL	PASSIVE_LEVEL

Share via