SerCx2CustomReceiveTransactionCreate (sercx.h)

Artikel
08/07/2023

Metode SerCx2CustomReceiveTransactionCreate membuat objek transaksi penerima kustom, yang digunakan ekstensi kerangka kerja serial (SerCx2) versi 2 untuk melakukan transaksi penerimaan kustom.

Sintaks

NTSTATUS SerCx2CustomReceiveTransactionCreate(
  [in]  SERCX2CUSTOMRECEIVE                       CustomReceive,
  [in]  PSERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG CustomReceiveTransactionConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES                    Attributes,
  [out] SERCX2CUSTOMRECEIVETRANSACTION            *CustomReceiveTransaction
);

Parameter

[in] CustomReceive

Handel SERCX2CUSTOMRECEIVE ke objek penerima kustom. Driver pengontrol serial sebelumnya disebut metode SerCx2CustomReceiveCreate untuk membuat objek ini.

[in] CustomReceiveTransactionConfig

Penunjuk ke struktur SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG . Sebelum memanggil metode ini, pemanggil harus memanggil fungsi SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG_INIT untuk menginisialisasi struktur. Struktur ini berisi pointer ke serangkaian rutinitas panggilan balik peristiwa yang diimplementasikan oleh driver pengontrol serial. SerCx2 memanggil fungsi-fungsi ini untuk melakukan transaksi I/O yang menggunakan mekanisme transfer data kustom untuk membaca data yang diterima oleh pengontrol serial.

[in] Attributes

Penunjuk ke struktur WDF_OBJECT_ATTRIBUTES yang menjelaskan atribut untuk ditetapkan ke objek transaksi penerima kustom baru. Sebelum memanggil metode ini, pemanggil harus memanggil fungsi WDF_OBJECT_ATTRIBUTES_INIT untuk menginisialisasi struktur. Parameter ini bersifat opsional dan dapat ditentukan sebagai WDF_NO_OBJECT_ATTRIBUTES jika driver pengontrol serial tidak perlu menetapkan atribut ke objek. Untuk informasi selengkapnya, lihat Keterangan.

[out] CustomReceiveTransaction

Penunjuk ke lokasi tempat metode ini menulis handel SERCX2CUSTOMRECEIVETRANSACTION ke objek transaksi penerima kustom yang baru dibuat. SerCx2 dan driver pengontrol serial menggunakan handel ini dalam panggilan berikutnya untuk merujuk ke objek ini.

Nilai kembali

Metode ini mengembalikan STATUS_SUCCESS jika panggilan berhasil. Kemungkinan nilai pengembalian kesalahan menyertakan kode status berikut.

Menampilkan kode	Deskripsi
STATUS_INVALID_DEVICE_REQUEST	Objek transaksi penerima kustom sudah ada dari panggilan SerCx2CustomReceiveTransactionCreate sebelumnya.
STATUS_INFO_LENGTH_MISMATCH	Nilai Ukuran CustomReceiveTransactionConfig-> tidak sama dengan sizeof(SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG).
STATUS_INVALID_PARAMETER	Nilai parameter tidak valid. Pemanggil harus menyediakan penunjuk fungsi EvtSerCx2CustomReceiveTransactionStart dan EvtSerCx2CustomReceiveTransactionQueryProgress yang valid.
STATUS_INSUFFICIENT_RESOURCES	Sumber daya yang tidak mencukuum tersedia untuk membuat objek transaksi penerima kustom.

Keterangan

Driver pengontrol serial Anda dapat memanggil metode ini untuk membuat objek transaksi penerima kustom. SerCx2 menggunakan objek ini untuk mengelola transaksi penerimaan kustom, yaitu transaksi I/O yang menggunakan mekanisme transfer data kustom untuk membaca data yang diterima oleh pengontrol serial.

Sebagai opsi, driver pengontrol serial dapat menggunakan parameter Atribut untuk membuat konteks untuk objek penerima kustom, dan untuk menyediakan pointer ke fungsi EvtCleanupCallback dan EvtDestroyCallback yang dipanggil untuk menyiapkan objek untuk dihapus. Untuk informasi selengkapnya, lihat WDF_OBJECT_ATTRIBUTES.

Jika parameter Atribut menunjuk ke struktur WDF_OBJECT_ATTRIBUTES , pemanggil tidak boleh menimpa nilai yang ditulis fungsi inisialisasi WDF_OBJECT_ATTRIBUTES_INIT ke anggota ParentObject, ExecutionLevel, dan SynchronizationScope dari struktur ini.

Jika kombinasi yang ditentukan dari fungsi panggilan balik yang diimplementasikan tidak valid, panggilan SerCx2CustomReceiveTransactionCreate gagal dan mengembalikan STATUS_INVALID_PARAMETER.

Untuk informasi selengkapnya tentang membuat objek transaksi penerima kustom, lihat SERCX2CUSTOMRECEIVETRANSACTION. Untuk informasi selengkapnya tentang transaksi penerima kustom, lihat SerCx2 Custom-Receive Transactions.