Flush (CPI-C)

  • [アーティクル]

Flush 呼び出し (関数名 cmflus) は、ローカル論理ユニット (LU) の送信バッファーの内容をパートナー LU (およびプログラム) に送信します。 送信バッファーが空の場合、アクションは行われません。

構文

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

パラメーター

conversation_ID
指定されたパラメーター。 会話の識別子を指定します。 このパラメーターの値は 、Initialize_Conversation または Accept_Conversationによって返されました。

return_code
この呼び出しから返されたコード。 有効なリターン コードについては、このトピックの後半で説明します。

リターン コード

CM_OK
プライマリ リターン コード。呼び出しが正常に実行されました。

CM_OPERATION_NOT_ACCEPTED
プライマリ リターン コード。この会話に対する前の操作が不完全です。

CM_OPERATION_INCOMPLETE
プライマリ リターン コード。操作が完了せず (処理モードは非ブロッキングのみ)、まだ進行中です。 プログラムは Wait_For_Conversation を発行して操作の完了を待機するか、操作と会話を取り消す Cancel_Conversation できます。 Specify_Windows_Handleが呼び出された場合、アプリケーションは Microsoft® Windows® メッセージによる通知を待機し、Wait_For_Conversationを呼び出す必要はありません。

CM_PROGRAM_PARAMETER_CHECK
プライマリ リターン コード。 conversation_ID で指定された値が無効です。

CM_PROGRAM_STATE_CHECK
プライマリ リターン コード。プログラムがこの呼び出しを発行したときに、メッセージ交換が SEND またはSEND_PENDING状態でなかった。

CM_PRODUCT_SPECIFIC_ERROR
プライマリ リターン コード。製品固有のエラーが発生し、製品エラー ログに記録されています。

State Changes (状態の変化)

会話は SEND またはSEND_PENDING状態である必要があります。

呼び出しが正常に完了した場合 (return_code がCM_OK)、会話は SEND 状態になります。

その他の戻りコードでは、状態は変更されません。

注釈

Send_Dataによって処理されたデータは、次のいずれかが発生するまでローカル LU 送信バッファーに蓄積されます。

  • ローカル プログラムは、LU 送信バッファーをフラッシュする Flush 呼び出しまたはその他の呼び出しを発行します。 (一部の送信の種類は、 Set_Send_Typeによって設定され、フラッシュ機能が含まれます)。

  • バッファーがいっぱいです。

    Allocate によって生成された 割り当て 要求と 、Send_Error によって生成されたエラー情報もバッファーに格納されます。