gtpc2mb8 | C/C++ Language Support User's Guide |
This function sets the partner_LU_name and
partner_LU_name_length characteristics. It overrides the
default value set by the cminit function.
Format
#include <tpfmap.h>
void cmspln(unsigned char *conversation_ID,
unsigned char *partner_LU_name,
signed int *partner_LU_name_length,
signed int *return_code);
- conversation_ID
- This is a pointer to an 8-byte character array that contains the
conversation ID. This conversation ID must be the ID returned by the
cminit (INITIALIZE) that started this conversation.
- partner_LU_name
- This is a pointer to an array of characters that specifies the new partner
LU name. This partner LU name specifies the remote LU or local
secondary LU (SLU) thread to be contacted when the ALLOCATE is
executed. The string can be as many as 17 characters, consisting of the
name of the LU's network, followed by a period, followed by the partner
LU name. The partner LU name can be as many as 8 characters. If
there is no period, the TPF system assumes only an LU name was
supplied.
- partner_LU_name_length
- This is a pointer to a 4-byte field that contains the length of the new
partner LU name. The value can be from 1 to 17 bytes.
- return_code
- This is a pointer to a 4-byte field where the return code is to be
placed.
Return Codes
The following is a list of return codes that can be returned to the program
that called the cmspln function. A complete list of the
return codes and their definitions can be found in Table 45.
- CM_OK
- CM_PRODUCT_SPECIFIC_ERROR
- CM_PROGRAM_PARAMETER_CHECK -- Either conversation_ID or
partner_LU_name_length is invalid.
- CM_PROGRAM_STATE_CHECK -- The program is not in initialize
state.
Programming Considerations
- You can execute this function on any I-stream.
- The conversation must be in initialize state.
- The value supplied in conversation_ID must be the conversation ID
returned by the cminit function.
- This function changes the value of the partner_LU_name and
partner_LU_name_length characteristics.
- This function causes no state change.
- If the new LU name is invalid, it is not detected until the ALLOCATE is
attempted.
- If return_code is not CM_OK, the partner_LU_name and
partner_LU_name_length characteristics remain unchanged.
- See the programming considerations for cmallc (cmallc-Allocate a Conversation) for additional considerations when setting this
characteristic.
Examples
The following example changes the partner_LU_name and
partner_LU_name_length characteristics.
#include <tpfmap.h>
unsigned char convid[8];
unsigned char name[17];
signed int len;
signed int rcode;
.
.
/* set conversation_ID with value returned from initialize */
.
.
cmspln(convid,name,&len,&rcode);
. /* normal processing path */
.
.
Related Information