Fungsi SerCx2CustomReceiveTransactionCreate (sercx.h)

Artikel
10/30/2024

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

Sintaksis

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 penunjuk 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 yang akan 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 SERCX2CUSTOMRECEIVETRANSACTION menangani objek transaksi penerimaan kustom yang baru dibuat. SerCx2 dan driver pengontrol serial menggunakan handel ini dalam panggilan berikutnya untuk merujuk ke objek ini.

Mengembalikan nilai

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

Mengembalikan kode	Deskripsi
STATUS_INVALID_DEVICE_REQUEST	Objek transaksi penerima kustom sudah ada dari SerCx2CustomReceiveTransactionCreate panggilan sebelumnya.
STATUS_INFO_LENGTH_MISMATCH	Nilai UkuranCustomReceiveTransactionConfig tidak sama dengan ukuran dari(SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG).
STATUS_INVALID_PARAMETER	Nilai parameter tidak valid. Pemanggil harus menyediakan EvtSerCx2CustomReceiveTransactionStart dan EvtSerCx2CustomReceiveTransactionQueryProgress penunjuk fungsi.
STATUS_INSUFFICIENT_RESOURCES	Sumber daya yang tidak mencukup tersedia untuk membuat objek transaksi penerima kustom.

Komentar

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 memasok pointer ke EvtCleanupCallback dan fungsi EvtDestroyCallback yang dipanggil untuk menyiapkan objek untuk penghapusan. 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 keParentObject , ExecutionLevel, dan SynchronizationScope anggota struktur ini.

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

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