Función AcxObjectBagRetrieveString (acxmisc.h)

La función AcxObjectBagRetrieveString recupera un objeto WDFSTRING de un AcxObjectBag inicializado existente.

Sintaxis

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

Parámetros

ObjectBag

Objeto ACX inicializado ObjectBag. Para obtener más información, vea ACX : resumen de objetos ACX.

ValueName

ValorName que se asociará a la cadena agregada y se usará para recuperar la cadena almacenada.

Value

Valor del objeto WDFSTRING que se va a recuperar de ObjectBag.

Valor devuelto

Devuelve STATUS_SUCCESS si la llamada se realizó correctamente. De lo contrario, devuelve un código de error adecuado. Para obtener más información, vea Uso de valores NTSTATUS.

Comentarios

Ejemplo

En este ejemplo se muestra el uso de 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);

Requisitos de ACX

Versión mínima de ACX: 1.0

Para obtener más información sobre las versiones de ACX, consulte Introducción a la versión de ACX.

Requisitos

Consulte también

• Encabezado acxmisc.h