Set_Return_Control (CPI-C)

  • [アーティクル]

呼び出し元のプログラムによって Set_Return_Control 呼び出し (関数名 cmsrc) が発行され、ローカル・プログラムからのセッション要求に対して動作するローカル論理装置 (LU) が呼び出しの 割り振り で制御をローカル・プログラムに戻すタイミングを指定します。

構文

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

パラメーター

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

return_control
指定されたパラメーター。 Allocate 呼び出しで動作するローカル LU がローカル プログラムに制御を返すタイミングを指定します。 使用できる値を次に示します。

CM_IMMEDIATE
LU は、競合勝者セッションをすぐに使用できる場合に割り当て、制御をプログラムに返します。

CM_WHEN_SESSION_ALLOCATED
LU は、セッションを割り当てるかエラーが発生するまで、プログラムに制御を戻しません。 セッションが使用できない場合、プログラムはセッションを待機します。 (セッション制限が 0 の場合、LU はすぐに制御を返します)。

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

リターン コード

CM_OK
主なリターン コード。呼び出しが正常に実行されました。

CM_PROGRAM_STATE_CHECK
主なリターン コード。会話が INITIALIZE 状態ではありません。

CM_PROGRAM_PARAMETER_CHECK
主なリターン コード。conversation_ID または return_control で指定された値が無効です。

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

State Changes (状態の変化)

会話は INITIALIZE 状態である必要があります。

状態の変更はありません。

注釈

この呼び出しは、 Initialize_Conversationによって確立された既定の戻り値コントロールをオーバーライドします。 既定では、セッションが割り当てられると制御が返されます。 Allocate 呼び出しが発行された後は、この呼び出しを発行できません。

セッションの詳細については、「 CPI-C アプリケーションの作成」を参照してください。

LU がセッションを割り当てることができない場合は、 Allocate 呼び出しで通知が返されます。