acxObjectBagRetrieveString 函式 (acxmisc.h)

  • 發行項

AcxObjectBagRetrieveString 函式會從現有初始化的 AcxObjectBag 擷取 WDFSTRING 物件。

語法

NTSTATUS AcxObjectBagRetrieveString(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  WDFSTRING        Value
);

參數

ObjectBag

初始化的 ObjectBag ACX 物件。 如需詳細資訊，請參閱 ACX - ACX 物件的摘要。

ValueName

ValueName，將會與新增的字串相關聯，並用來擷取預存字串。

Value

要從 ObjectBag 擷取的 WDFSTRING 物件值。

傳回值

如果呼叫成功，則傳 STATUS_SUCCESS 回 。 否則，它會傳回適當的錯誤碼。 如需詳細資訊，請參閱 使用NTSTATUS值。

備註

範例

此範例示範 AcxObjectBagRetrieveString 的使用。

    status = RtlUnicodeStringInit(&usName, inParams->ValueName);
    if (!NT_SUCCESS(status))
    {
        DrvLogError(g_RecorderLog, FLAG_DDI, 
                    "WDFDEVICE %p, RtlUnicodeStringInit(%S) failed, %!STATUS!", 
                    m_Device, inParams->ValueName, status);
        goto exit;
    }

    //
    // Set the specified property.
    //
    switch(inParams->ValueType)
    {
    case REG_SZ:
        //
        // Create an empty WDF string to get the value.
        //
        status = WdfStringCreate(nullptr, nullptr, &wsValue);
        if (!NT_SUCCESS(status))
        {
            DrvLogError(g_RecorderLog, FLAG_DDI, 
                        "WDFDEVICE %p, WdfStringCreate failed, %!STATUS!", 
                        m_Device, status);
            goto exit;
        }

        //
        // Get the string value from bag.
        //
        status = AcxObjectBagRetrieveString(objBag, &usName, wsValue);

ACX 需求

最小 ACX 版本： 1.0

如需 ACX 版本的詳細資訊，請參閱 ACX 版本概觀。

規格需求

需求 值
標頭 acxmisc.h
IRQL PASSIVE_LEVEL

另請參閱