AcxObjectBagAddI2 関数 (acxmisc.h)

AcxObjectBagAddI2 関数は、int 2 バイト I2 (SHORT) 値を既存の初期化された AcxObjectBag に追加します。

構文

NTSTATUS AcxObjectBagAddI2(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  SHORT            Value
);

パラメーター

ObjectBag

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

ValueName

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

Value

ObjectBag に追加する値。

戻り値

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

解説

例

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

    ACXOBJECTBAG objBag     = NULL;
    SHORT        i2Value    = 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, TestI2);

    i2Value = 1;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddI2(objBag, &TestI2, i2Value));

    // Retrieve the value from the object bag
    i2Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveI2(objBag, &TestI2, &i2Value));

ACX の要件

最小 ACX バージョン: 1.0

ACX バージョンの詳細については、「 ACX バージョンの概要」を参照してください。

要件

こちらもご覧ください

• acxmisc.h ヘッダー