Metode IWDFUsbTargetPipe::RetrievePipePolicy (wudfusb.h)

[Peringatan: UMDF 2 adalah versi terbaru UMDF dan pengganti UMDF 1. Semua driver UMDF baru harus ditulis menggunakan UMDF 2. Tidak ada fitur baru yang ditambahkan ke UMDF 1 dan ada dukungan terbatas untuk UMDF 1 pada versi Windows 10 yang lebih baru. Driver Universal Windows harus menggunakan UMDF 2. Untuk informasi selengkapnya, lihat Mulai menggunakan UMDF.]

Metode RetrievePipePolicy mengambil kebijakan pipa WinUsb.

Sintaks

HRESULT RetrievePipePolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

Parameter

[in] PolicyType

Jenis kebijakan pipa WinUsb yang diminta driver UMDF.

[in, out] ValueLength

Penunjuk ke variabel yang, pada input, berisi ukuran, dalam byte, dari buffer yang disediakan RetrievePipePolicy untuk Nilai. Pada output, parameter ini berisi ukuran yang diperlukan RetrievePipePolicy untuk Value.

[out] Value

Pointer yang menerima buffer yang berisi kebijakan pipa WinUsb.

Nilai kembali

RetrievePipePolicy mengembalikan salah satu nilai berikut:

Menampilkan kode	Deskripsi
S_OK	RetrievePipePolicy berhasil mengambil kebijakan pipa WinUsb.
E_OUTOFMEMORY	RetrievePipePolicy mengalami kegagalan alokasi.
Kode kesalahan yang didefinisikan dalam Winerror.h	Nilai ini sesuai dengan kode kesalahan yang dikembalikan API WinUsb.

Keterangan

Kebijakan pipa mengontrol perilaku pipa USB (misalnya, waktu habis, menangani paket pendek, dan sebagainya).

Untuk informasi selengkapnya tentang jenis kebijakan valid yang dapat diteruskan driver UMDF untuk parameter PolicyType dan nilai yang dikembalikan kerangka kerja, lihat fungsi WinUsb_GetPipePolicy .

Untuk informasi tentang perilaku kebijakan pipa, lihat Fungsi WinUSB untuk Modifikasi Kebijakan Pipa.

Metode RetrievePipePolicy menghasilkan permintaan UMDF dan secara sinkron mengirim permintaan ke target I/O.

Persyaratan

Persyaratan	Nilai
Akhir dukungan	Tidak tersedia di UMDF 2.0 dan yang lebih baru.
Target Platform	Desktop
Versi UMDF minimum	1,5
Header	wudfusb.h (termasuk Wudfusb.h)
DLL	WUDFx.dll

Lihat juga

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy