SNAP-IX CPI-C Programmer's Guide - 3.49 Set_Local_LU

3.49 Set_Local_LU_Name (cmslln)

The Set_Local_LU_Name call is issued by the invoking program to specify the local LU for a conversation. This call overrides the system-defined Local LU derived from the side information when Initialize_Conversation was issued, and any Local LU specified by the APPCLLU environment variable. This call cannot be issued after the Allocate has been issued. Issuing this call has no effect on the side information itself.

This call is not part of the standard CPI-C specification, and may not be available in other implementations. In particular, it is not supported in other Java CPI-C implementations.

3.49.1 Function Call

void cmslln   (
               unsigned char CM_PTR         Conversation_ID,
               unsigned char CM_PTR         lu_alias,
               CM_INT32 CM_PTR              lu_alias_length,
               CM_RETURN_CODE CM_PTR        return_code
              );

3.49.2 Function Call for Java CPI-C

     public native void cmslln (
                                 byte[]          conversation_ID,
                                 byte[]          lu_alias,
                                 CPICLength      lu_alias_length,
                                 CPICReturnCode  return_code
                               );

3.49.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.
lu_alias: This parameter specifies the starting address of the LU alias. The LU alias can contain up to eight ASCII characters.
lu_alias_length: This parameter specifies the length of the LU alias. The range for this value is 0-8 bytes. If lu_alias_length is 0 (zero), the LU alias is set to all zeros.

3.49.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_STATE_CHECK

The conversation is not in Initialize state.

CM_PROGRAM_PARAMETER_CHECK

One of the following has occurred:

The value specified by conversation_ID is not valid
The value specified by lu_alias_length is out of range (greater than 8 or less than 0).

CM_PRODUCT_SPECIFIC_ERROR

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

3.49.5 State When Issued

The conversation must be in Initialize state.

3.49.6 State Change

There is no state change.

3.49.7 Usage Notes

If the return_code is not CM_OK , the lu_alias conversation characteristic is unchanged.

Specifying a value for lu_alias that is not valid (a name that is not permitted by the configuration file) is not detected until the Allocate call is issued.