FILTER_OID_REQUEST fungsi panggilan balik (ndis.h)
NDIS memanggil fungsi FilterOidRequest driver filter untuk memproses permintaan OID yang terkait dengan modul filter yang ditentukan.
Sintaks
FILTER_OID_REQUEST FilterOidRequest;
NDIS_STATUS FilterOidRequest(
[in] NDIS_HANDLE FilterModuleContext,
[in] PNDIS_OID_REQUEST OidRequest
)
{...}
Parameter
[in] FilterModuleContext
Handel ke area konteks untuk modul filter yang merupakan target permintaan ini. Driver filter membuat dan menginisialisasi area konteks ini dalam fungsi FilterAttach .
[in] OidRequest
Penunjuk ke struktur NDIS_OID_REQUEST yang menentukan operasi yang diminta termasuk kode OID_XXX . Struktur dapat menentukan permintaan kueri OID atau permintaan set OID. Untuk informasi selengkapnya tentang OID, lihat OID NDIS.
Nilai kembali
FilterOidRequest mengembalikan salah satu nilai status berikut:
Menampilkan kode | Deskripsi |
---|---|
|
FilterOidRequest berhasil menyelesaikan kueri driver filter atau mengatur operasi untuk modul filter ini. |
|
Menunjukkan bahwa driver filter akan menyelesaikan permintaan secara asinkron. Setelah driver menyelesaikan permintaan, driver harus memanggil Fungsi NdisFOidRequestComplete untuk memberi tahu NDIS bahwa permintaan selesai. |
|
Menunjukkan bahwa permintaan, yang ditentukan di OidRequest, tidak valid atau tidak dikenali. |
|
FilterOidRequest tidak mendukung OID, OID bersifat opsional. |
|
Menunjukkan bahwa buffer, yang disediakan di OidRequest, terlalu kecil untuk menyimpan data yang diminta. |
|
Untuk operasi kueri, anggota InformationBufferLength dari struktur NDIS_OID_REQUEST tidak cocok dengan panjang yang diperlukan oleh OID yang diberikan. FilterOidRequest mengembalikan ukuran buffer yang diperlukan, dalam byte, di anggota BytesNeeded dari struktur NDIS_OID_REQUEST. |
|
Untuk operasi set, data yang disediakan dalam anggota InformationBuffer dari struktur NDIS_OID_REQUEST tidak valid untuk OID yang diberikan. |
|
FilterOidRequest mencoba mengumpulkan informasi yang diminta tetapi tidak berhasil. |
|
FilterOidRequest gagal karena sumber daya yang tidak mencukup. |
|
FilterOidRequest mengembalikan NDIS_STATUS_FAILURE jika tidak ada nilai sebelumnya yang berlaku. Driver filter harus memanggil fungsi NdisWriteErrorLogEntry dengan parameter yang menentukan alasan kegagalan. |
Keterangan
FilterOidRequest adalah fungsi opsional. Jika driver filter tidak menggunakan permintaan OID, itu dapat mengatur titik masuk untuk fungsi ini ke NULL saat memanggil fungsi NdisFRegisterFilterDriver . Jika driver filter menentukan fungsi FilterOidRequestComplete , driver filter harus menyediakan fungsi FilterOidRequest .
NDIS memanggil fungsi FilterOidRequest driver filter untuk memproses permintaan OID yang berasal dari driver yang terlalu mengandalkan. Driver filter dapat meneruskan permintaan tersebut ke driver yang mendasar dengan memanggil fungsi NdisFOidRequest .
Sebelum driver memanggil NdisFOidRequest, driver harus mengalokasikan struktur NDIS_OID_REQUEST dan mentransfer informasi permintaan ke struktur baru dengan memanggil NdisAllocateCloneOidRequest. Sebagai opsi, driver filter dapat segera menyelesaikan permintaan tanpa meneruskan permintaan.
Untuk menyelesaikan permintaan secara sinkron, driver filter mengembalikan NDIS_STATUS_SUCCESS atau status kegagalan. Jika driver mengembalikan NDIS_STATUS_PENDING, driver harus memanggil fungsi NdisFOidRequestComplete untuk memberi tahu NDIS bahwa permintaan selesai.
Untuk operasi kueri, FilterOidRequest mengembalikan informasi yang diminta di anggota InformationBuffer dan mengatur variabel di anggota BytesWritten dari struktur NDIS_OID_REQUEST ke jumlah informasi yang dikembalikannya. Driver yang mendasar melakukan ini jika driver filter meneruskan permintaan dengan NdisFOidRequest.
Untuk operasi set, FilterOidRequest dapat menggunakan data di anggota InformationBuffer dari struktur NDIS_OID_REQUEST untuk mengatur informasi yang diperlukan oleh OID yang diberikan. Dalam hal ini, FilterOidRequest mengatur variabel di BytesRead ke jumlah data yang disediakan yang digunakannya. Driver yang mendasar melakukan ini jika driver filter meneruskan permintaan dengan NdisFOidRequest.
Seperti driver miniport, driver filter hanya dapat menerima satu permintaan pada satu waktu. NDIS menserialisasikan permintaan yang dikirimnya ke driver filter. NDIS tidak dapat memanggil FilterOidRequest sebelum driver filter menyelesaikan permintaan saat ini.
NDIS memanggil FilterOidRequest di IRQL <= DISPATCH_LEVEL.
Contoh
Untuk menentukan fungsi FilterOidRequest , Anda harus terlebih dahulu memberikan deklarasi fungsi yang mengidentifikasi jenis fungsi yang Anda tentukan. Windows menyediakan sekumpulan tipe fungsi untuk pengandar. Mendeklarasikan fungsi menggunakan jenis fungsi membantu Analisis Kode untuk Driver, Pemverifikasi Driver Statis (SDV), dan alat verifikasi lainnya menemukan kesalahan, dan itu adalah persyaratan untuk menulis driver untuk sistem operasi Windows.Misalnya, untuk menentukan fungsi FilterOidRequest yang diberi nama "MyOidRequest", gunakan jenis FILTER_OID_REQUEST seperti yang ditunjukkan dalam contoh kode ini:
FILTER_OID_REQUEST MyOidRequest;
Kemudian, terapkan fungsi Anda sebagai berikut:
_Use_decl_annotations_
NDIS_STATUS
MyOidRequest(
NDIS_HANDLE FilterModuleContext,
PNDIS_OID_REQUEST OidRequest
)
{...}
Jenis fungsi FILTER_OID_REQUEST ditentukan dalam file header Ndis.h. Untuk mengidentifikasi kesalahan secara lebih akurat saat Anda menjalankan alat analisis kode, pastikan untuk menambahkan anotasi Use_decl_annotations ke definisi fungsi Anda. Anotasi Use_decl_annotations memastikan bahwa anotasi yang diterapkan ke jenis fungsi FILTER_OID_REQUEST dalam file header digunakan. Untuk informasi selengkapnya tentang persyaratan untuk deklarasi fungsi, lihat Mendeklarasikan Fungsi dengan Menggunakan Jenis Peran Fungsi untuk Driver NDIS.
Untuk informasi tentang Use_decl_annotations, lihat Perilaku Fungsi Anotasi.
Persyaratan
Persyaratan | Nilai |
---|---|
Klien minimum yang didukung | Didukung di NDIS 6.0 dan yang lebih baru. |
Target Platform | Windows |
Header | ndis.h (termasuk Ndis.h) |
IRQL | <= DISPATCH_LEVEL |