3.50.1 Function Call

     void cmsld (
                 unsigned char CM_PTR       conversation_ID,
                 unsigned char CM_PTR       log_data,
                 CM_INT32 CM_PTR            log_data_length,
                 CM_RETURN_CODE CM_PTR      return_code
                );

3.50.2 Function Call for Java CPI-C

     public native void cmsld (
                                byte[]          conversation_ID,
                                byte[]          log_data,
                                CPICLength      log_data_length,
                                CPICReturnCode  return_code
                              );

3.50.3 Supplied Parameters

The supplied parameters are:

conversation_ID

This is the identifier for the conversation. The value of this parameter is returned by the Initialize_Conversation, Initialize_For_Incoming, or Accept_Conversation call.

log_data

Address of data buffer containing error information. This data is sent to the local error log and to the partner LU.

This parameter is used by the Send_Error call if log_data_length is greater than 0 (zero).

The program must format the error data as a General Data Stream (GDS) error log variable. For further information, refer to the IBM publication IBM Systems Network Architecture: LU 6.2 Reference: Peer Protocols.

log_data_length

This parameter specifies the length of the log data.

The range for this value is 0-512 bytes.

A length of 0 (zero) indicates that there is no log data. The log_data parameter is ignored, and the log_data conversation characteristic is set to a null string.

3.50.4 Returned Parameters

After the verb executes, SNAP-IX returns the following parameters:

return_code

Possible values are:

CM_OK

The call executed successfully.

CM_PROGRAM_PARAMETER_CHECK

One of the following has occurred:

• The value specified by conversation_ID is not valid.

• The conversation type is set to mapped.

• The value specified by log_data_length is out of range (greater than 512 or less than 0).

CM_PRODUCT_SPECIFIC_ERROR

For an explanation of this return code, see Common Return Codes.

3.50.5 State When Issued

The conversation can be in any state except Reset.

3.50.6 State Change

There is no state change.

3.50.7 Usage Notes

If the return_code is not CM_OK , the log_data and log_data_length conversation characteristics are unchanged.

The log data specified by the Set_Log_Data call is sent to the partner LU when the local program issues one of the following calls:

• Send_Error

• Deallocate with the conversation's deallocate_type set to CM_DEALLOCATE_ABEND

• Send_Data with the conversation's send_type set to CM_SEND_AND_DEALLOCATE and the deallocate_type set to CM_DEALLOCATE_ABEND

After sending the log data to the partner LU, the local LU resets the log data to null and the log data length to 0 (zero).

CPI-C automatically converts the log data from ASCII to EBCDIC as required.