Flush (CPI-C)

2023-07-21

Panggilan Flush (nama fungsi cmflus) mengirimkan konten buffer pengiriman unit logis lokal (LU) ke LU (dan program) mitra. Jika buffer kirim kosong, tidak ada tindakan yang terjadi.

Sintaks

  
CM_ENTRY Flush(   
  unsigned char FAR *conversation_ID,    
  CM_INT32 FAR *return_code              
);

Parameter

conversation_ID
Parameter yang disediakan. Menentukan pengidentifikasi untuk percakapan. Nilai parameter ini dikembalikan oleh Initialize_Conversation atau Accept_Conversation.

return_code
Kode yang dikembalikan dari panggilan ini. Kode pengembalian yang valid dicantumkan nanti dalam topik ini.

Mengembalikan kode

CM_OK
Kode pengembalian utama; panggilan berhasil dijalankan.

CM_OPERATION_NOT_ACCEPTED
Kode pengembalian utama; operasi sebelumnya pada percakapan ini tidak lengkap.

CM_OPERATION_INCOMPLETE
Kode pengembalian utama; operasi belum selesai (mode pemrosesan tidak memblokir saja) dan masih berlangsung. Program ini dapat mengeluarkan Wait_For_Conversation untuk menunggu penyelesaian operasi, atau Cancel_Conversation untuk membatalkan operasi dan percakapan. Jika Specify_Windows_Handle telah dipanggil, aplikasi harus menunggu pemberitahuan oleh pesan Microsoft® Windows® dan tidak memanggil Wait_For_Conversation.

CM_PROGRAM_PARAMETER_CHECK
Kode pengembalian utama; nilai yang ditentukan oleh conversation_ID tidak valid.

CM_PROGRAM_STATE_CHECK
Kode pengembalian utama; percakapan tidak dalam status KIRIM atau SEND_PENDING ketika program mengeluarkan panggilan ini.

CM_PRODUCT_SPECIFIC_ERROR
Kode pengembalian utama; terjadi kesalahan khusus produk dan telah dicatat dalam log kesalahan produk.

Perubahan Status

Percakapan harus dalam status KIRIM atau SEND_PENDING.

Jika panggilan berhasil diselesaikan, (return_code CM_OK), percakapan dalam status KIRIM.

Kode pengembalian lainnya tidak menghasilkan perubahan status.

Keterangan

Data yang diproses oleh Send_Data terakumulasi di LUs lokal mengirim buffer hingga salah satu hal berikut ini terjadi:

Program lokal mengeluarkan panggilan Flush atau panggilan lain yang menghapus buffer pengiriman LUs. (Beberapa jenis pengiriman, diatur oleh Set_Send_Type, termasuk fungsionalitas flush.)
Buffer penuh.

Permintaan alokasi yang dihasilkan oleh Alokasi dan informasi kesalahan yang dihasilkan oleh Send_Error juga di-buffer.

Bagikan melalui