Função AcxObjectBagRetrieveString (acxmisc.h)

A função AcxObjectBagRetrieveString recupera um objeto WDFSTRING de um AcxObjectBag inicializado existente.

Sintaxe

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

Parâmetros

ObjectBag

Um objeto ACX ObjectBag inicializado. Para obter mais informações, consulte ACX – Resumo de objetos ACX.

ValueName

Um ValueName que será associado à cadeia de caracteres adicionada e será usado para recuperar a cadeia de caracteres armazenada.

Value

O valor do objeto WDFSTRING a ser recuperado do ObjectBag.

Retornar valor

Retorna STATUS_SUCCESS se a chamada foi bem-sucedida. Caso contrário, ele retornará um código de erro apropriado. Para obter mais informações, consulte Usando valores NTSTATUS.

Comentários

Exemplo

Este exemplo mostra o 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 do ACX

Versão mínima do ACX: 1.0

Para obter mais informações sobre versões do ACX, consulte Visão geral da versão do ACX.

Requisitos

Confira também

• Cabeçalho acxmisc.h