WdfChildListRetrieveAddressDescription 函式 (wdfchildlist.h)

  • 發行項

[僅適用於 KMDF]

WdfChildListRetrieveAddressDescription 方法會找出具有指定標識符描述的子裝置，並擷取裝置的位址描述。

語法

NTSTATUS WdfChildListRetrieveAddressDescription(
  [in]      WDFCHILDLIST                                 ChildList,
  [in]      PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
  [in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER        AddressDescription
);

參數

[in] ChildList

子清單物件的句柄。

[in] IdentificationDescription

呼叫端配置的 WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 結構的指標，可識別驅動程式提供的子識別描述。

[in, out] AddressDescription

識別子位址描述之 WDF_CHILD_ADDRESS_DESCRIPTION_HEADER 結構的指標。 架構會填入此描述。

傳回值

WdfChildListRetrieveAddressDescription 會傳回STATUS_SUCCESS，如果作業成功， NT_SUCCESS (状态) 等於 TRUE 的另一個狀態值。 否則，此方法可能會傳回下列其中一個值：

傳回碼 Description
STATUS_INVALID_PARAMETER
 輸入參數無效。
STATUS_NO_SUCH_DEVICE
 沒有裝置符合指定的識別描述。
STATUS_INVALID_DEVICE_REQUEST
 子清單不包含位址描述，或 AddressDescription 指定的位址描述大小不正確。
 

這個方法也可能傳回其他 NTSTATUS值。

如果驅動程式提供無效的物件句柄，就會發生系統錯誤檢查。

備註

如需子清單的詳細資訊，請參閱 動態列舉。

範例

下列程式代碼範例會搜尋子裝置清單，其標識元描述包含 SomeValue所指定的值。 如果 WdfChildListRetrieveAddressDescription 找到裝置，它會擷取裝置的位址描述。

MY_IDENTIFICATION_DESCRIPTION  id;
MY_ADDRESS_DESCRIPTION  addrDescrip;

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
                                                 &id.Header,
                                                 sizeof(id)
                                                 );
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT(
                                          &addrDescrip.Header,
                                          sizeof(addrDescrip)
                                          );

id.DeviceIdentifier = SomeValue;
status = WdfChildListRetrieveAddressDescription(
                                                list,
                                                &idDescrip.Header,
                                                &addrDescrip.Header
                                                );
if (!NT_SUCCESS(status) {
    return status;
}

規格需求

需求 值
目標平台 Universal
最小 KMDF 版本 1.0
標頭 wdfchildlist.h (包含 Wdf.h)
程式庫 Wdf01000.sys (請參閱 Framework Library Versioning.)
IRQL <= DISPATCH_LEVEL
DDI 合規性規則 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另請參閱

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT