gtpc2mav | C/C++ Language Support User's Guide |
This function returns the current value of the mode_name and
mode_name_length characteristics.
Format
#include <tpfmap.h>
void cmemn(unsigned char *conversation_ID,
unsigned char *mode_name,
signed int *mode_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) or cmaccp (ACCEPT_CONVERSATION) that
started this conversation.
- mode_name
- This is a pointer to an array of characters where the mode name for this
conversation is to be placed. The string must allow for as many as 8
characters. The previous contents of the string is overwritten on
return.
- mode_name_length
- This is a pointer to a 4-byte field where the length of the mode name is
to be placed. Trailing blanks are not included.
- 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 cmemn 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 -- The specified conversation_ID
is invalid.
Programming Considerations
- You can execute this function on any I-stream.
- The conversation can be in any state.
- The value supplied in conversation_ID must be the conversation ID
returned by the cmaccp or cminit function.
- This function does not change the mode_name or
mode_name_length characteristics.
- If return_code is not CM_OK, mode_name and
mode_name_length do not return meaningful values.
Examples
The following example gets the mode name for the conversation.
#include <tpfmap.h>
unsigned char convid[8];
unsigned char name[8];
signed int length;
signed int rcode;
.
.
/* set conversation_ID with value returned from accept or initialize */
.
.
cmemn(convid,name,&length,&rcode);
. /* normal processing path */
.
.
Related Information