AcxObjectBagAddUI2 関数 (acxmisc.h)

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

構文

NTSTATUS AcxObjectBagAddUI2(
  ACXOBJECTBAG     ObjectBag,
  PCUNICODE_STRING ValueName,
  USHORT           Value
);

パラメーター

ObjectBag

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

ValueName

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

Value

ObjectBag に追加する値。

戻り値

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

備考

例

この例では、AcxObjectBagAddUI2 の使用を示します。

    ACXOBJECTBAG objBag     = NULL;
    USHORT       ui2Value   = 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, TestUI2);

    ui2Value = 0x55;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagAddUI2(objBag, &TestUI2, ui2Value));

    // Retrieve the value from the object bag
    ui2Value = 0;
    RETURN_NTSTATUS_IF_FAILED(AcxObjectBagRetrieveUI2(objBag, &TestUI2, &ui2Value));

ACX の要件

最小 ACX バージョン: 1.0

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

必要条件

要件	価値
ヘッダー	acxmisc.h
IRQL	PASSIVE_LEVEL

関連項目

• acxmisc.h ヘッダー を する