AcxObjectBagRetrieveI1 関数 (acxmisc.h)

重要

一部の情報は、市販される前に大幅に変更される可能性があるプレリリース製品に関連しています。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

AcxObjectBagRetrieveI1 関数は、値を含む既存の初期化された AcxObjectBag から int 1 バイト (CHAR) I1 値を取得します。

構文

NTSTATUS AcxObjectBagRetrieveI1(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  CHAR             *Value
);

パラメーター

ObjectBag

初期化された ObjectBag ACX オブジェクト。 詳細については、「 ACX - ACX オブジェクトの概要」を参照してください。

ValueName

値へのアクセスに使用される値の名前。

Value

ObjectBag から取得する値。

戻り値

STATUS_SUCCESS呼び出しが成功したかどうかを返します。 それ以外の場合は、適切なエラー コードが返されます。 詳細については、「 NTSTATUS 値の使用」を参照してください。

解説

この例では、AcxObjectBagRetrieveI1 の使用方法を示します。

    ACXOBJECTBAG objBag     = NULL;
    CHAR         i1Value    = 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, TestI1);

    i1Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddI1(objBag, &TestI1, i1Value)

    // Retrieve the value from the object bag
    i1Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveI1(objBag, &TestI1, &i1Value));

必要条件

   
ヘッダー acxmisc.h

関連項目