Set_Log_Data (CPI-C)

Set_Log_Data呼び出し (関数名 cmsld) は、ログ メッセージ (ログ データ) と、パートナー論理ユニット (LU) に送信されるその長さを指定します。 この呼び出しは、基本的な会話でのみ許可されます。 これは、既定のログ データ (null) と既定のログ データ長 (ゼロ) をオーバーライドします。

構文

  
CM_ENTRY Set_Log_Data(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *log_data,           
  CM_INT32 FAR *log_data_length,         
  CM_INT32 FAR *return_code              
);  

パラメーター

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

log_data
指定されたパラメーター。 パートナー LU に送信するデータの開始アドレスを指定します。 最大 512 文字の ASCII 文字を含めることができます。 使用できる文字は次のとおりです。

  • 大文字と小文字。

  • 0 ~ 9 の数字。

  • 特殊文字。

  • スペース。

    log_data_length
    指定されたパラメーター。 ログ データの長さを指定します。 範囲は 0 ~ 512 バイトです。

    長さが 0 の場合は、ログ データがないことを示し、 log_data パラメーターは無視されます。

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

リターン コード

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

CM_PROGRAM_PARAMETER_CHECK
プライマリ リターン コード。次のいずれかが発生しました。

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

  • 会話の種類は にマップされます。

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

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

State Changes (状態の変化)

会話は RESET 以外の任意の状態にすることができます。

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

注釈

ローカル・プログラムが以下のいずれかの呼び出しを発行すると、 Set_Log_Data によって指定されたログ・データがパートナー LU に送信されます。

  • Send_Error

  • 会話の割り当てを解除する型を CM_DEALLOCATE_ABEND に設定して割り当てを解除する

  • スレッド 送信の種類が CM_SEND_AND_DEALLOCATE に設定され、割り当て解除の種類が CM_DEALLOCATE_ABEND に設定されているSend_Data

    ログ データをパートナー LU に送信すると、ローカル LU によってログ データが null にリセットされ、ログ データの長さが 0 にリセットされます。

    CPI-C は、必要に応じてログ・データを ASCII から EBCDIC などの他のエンコード標準に自動的に変換します。