Set_Return_Control (CPI-C)

调用程序发出Set_Return_Control调用 (函数名称 cmsrc) ,以指定何时本地逻辑单元 (LU) (根据本地程序 Allocate 调用的会话请求)应将控制权返回给本地程序。

语法

  
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 不会将控制权返回给程序,直到它分配会话或遇到错误。 如果会话不可用,程序将等待一个会话。 (如果会话限制为零,LU 将立即返回控制权。)

return_code
从此调用返回的代码。 本主题后面列出了有效的返回代码。

返回代码

CM_OK
主返回代码;调用已成功执行。

CM_PROGRAM_STATE_CHECK
主返回代码;会话未处于 INITIALIZE 状态。

CM_PROGRAM_PARAMETER_CHECK
主返回代码; 由 conversation_IDreturn_control 指定的值无效。

CM_PRODUCT_SPECIFIC_ERROR
主返回代码;发生特定于产品的错误,并且已记录在产品错误日志中。

状态更改

会话必须处于 INITIALIZE 状态。

没有状态更改。

注解

此调用将替代 Initialize_Conversation建立的默认返回控件。 默认情况下,在分配会话时返回控制权。 发出 Allocate 调用后,无法发出此调用。

有关会话的详细信息,请参阅 编写 CPI-C 应用程序

如果 LU 无法分配会话,则会在 Allocate 调用中返回通知。