Set_Mode_Name (CPI-C)

  • [アーティクル]

Set_Mode_Name呼び出し (関数名 cmsmn) は、会話のモード名を指定するために呼び出し元のプログラムによって発行されます。 この呼び出しは、 Initialize_Conversation 呼び出しが発行されたときにサイド情報から派生したシステム定義モード名をオーバーライドします。 Allocateが発行された後は、この呼び出しを発行できません。 この呼び出しを発行しても、サイド 情報自体には影響しません。

構文

  
CM_ENTRY Set_Mode_Name(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *mode_name,      
  CM_INT32 FAR *mode_name_length,    
  CM_INT32 FAR *return_code          
);

パラメーター

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

mode_name
指定されたパラメーター。 モード名の開始アドレス (構成時に定義されたネットワーク特性のセットの名前) を指定します。 モード名には、最大 8 文字の ASCII 文字を含めることができます。 使用できる文字は次のとおりです。

  • 大文字。

  • 0 ~ 9 の数字。

    mode_nameの値は、構成時にパートナー論理ユニット (LU) に関連付けられているモードの名前と一致している必要があります。 モード名を SNASVCMG または CPSVCMG にすることはできません。

    mode_name_length
    指定されたパラメーター。 モード名の長さを指定します。 範囲は 0 ~ 8 バイトです。

    mode_name_lengthが 0 に設定されている場合、Set_Mode_Nameは無視されます。

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

リターン コード

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

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

CM_PROGRAM_PARAMETER_CHECK
主なリターン コード。次のいずれかが発生しました。

  • conversation_IDで指定された値が無効です。

  • mode_name_lengthで指定された値が範囲外 (8 より大きいか、0 未満) です。

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

State Changes (状態の変化)

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

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

注釈

mode_nameに無効な値を指定することは、Allocate が発行されるまで検出されません。