DEFINE_CPIC_SIDE_INFO

This verb adds or replaces a side information entry in memory. A CPI-C side information entry associates a set of conversation characteristics with a symbolic destination name. If there is already a side information entry in memory with the same symbolic destination name as the one supplied with this verb, it is overwritten with the data supplied to this call. Refer to CPI-C Reference for more information about the CPI-C support provided by Personal Communications or Communications Server.

VCB Structure

typedef struct define_cpic_side_info
{
   unsigned short  opcode;             /* verb operation code          */
   unsigned char   reserv2;            /* reserved                     */
   unsigned char   format;             /* format                       */
   unsigned short  primary_rc;         /* primary return code          */
   unsigned long   secondary_rc;       /* secondary return code        */
   unsigned char   reserv2a[8];        /* reserved                     */
   unsigned char   sym_dest_name[8];   /* Symbolic destination name    */
   CPIC_SIDE_INFO_DEF_DATA def_data;   /* defined data                 */
} DEFINE_CPIC_SIDE_INFO;
typedef struct cpic_side_info_def_data
{
   unsigned char   description[RD_LEN];
                                       /* resource description         */
   CPIC_SIDE_INFO  side_info;          /* CPIC side info               */
   unsigned char   user_data[32];      /* User defined data            */
} CPIC_SIDE_INFO_DEF_DATA;
typedef struct cpic_side_info
{
   unsigned char   partner_lu_name[17];
                                       /* Fully qualified partner      */
                                       /* LU name                      */
   unsigned char   reserved[3];        /* Reserved                     */
   unsigned long   tp_name_type;       /* TP name type                 */
   unsigned char   tp_name[64];        /* TP name                      */
   unsigned char   mode_name[8];       /* Mode name                    */
   unsigned long   conversation_security_type;
                                       /* Conversation security type   */
   unsigned char   security_user_id[CPIC_SECURITY_INFO_LEN];
                                       /* User ID                      */
   unsigned char   security_password[CPIC_SECURITY_INFO_LEN];
                                       /* Password                     */
} CPIC_SIDE_INFO;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_DEFINE_CPIC_SIDE_INFO
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
sym_dest_name
Symbolic destination name that identifies the side information entry. This is up to 8 bytes long, padded with spaces, in the locally displayable character set. The allowed characters are the uppercase letters (A to Z) and the digits 0–9.
def_data.description
Resource description (returned on QUERY_CPIC_SIDE_INFO). This is a 16-byte string in a locally displayable character set. All 16 bytes are significant.
def_data.side_info.partner_lu_name
Fully qualified name of the partner LU. This name is 17 bytes long and is right-padded with spaces, in the locally displayable character set. It is composed of two character strings concatenated by a dot. (Each name can have a maximum length of 8 bytes with no embedded spaces.)
def_data.side_info.tp_name_type
Transaction program name type. This field is set to one of the following values:
XC_APPLICATION_TP
Specifies that the transaction program name supplied is not a service transaction program. All characters specified in the transaction program name must be valid characters in the locally displayable character set.
XC_SNA_SERVICE_TP
Specifies that the transaction program name supplied is that of a service transaction program. All characters, except the first, specified in the transaction program must be valid characters in the locally displayable character set. The first character must be a hexadecimal digit in the range X'01' to X'3F', excluding X'0E' and X'0F'.
def_data.side_info.tp_name
Transaction program name, a 64-byte character string in the locally displayable character set, right-padded with spaces.
def_data.side_info.mode_name
Mode name, an 8-byte character string in the locally displayable character set, padded to the right with spaces.
def_data.side_info.conversation_security_type
Conversation security type. This field is set to one of the following values:

XC_SECURITY_NONE
XC_SECURITY_SAME
XC_SECURITY_PROGRAM
XC_SECURITY_PROGRAM_STRONG.

def_data.side_info.security_user_id
User ID. Personal Communications or Communications Server will use this field for enforcing conversation-level security.
def_data.side_info.security_password
Password. Personal Communications or Communications Server will use this field for enforcing conversation-level security.
def_data.user_data
User data. This data is returned on QUERY_CPIC_SIDE_INFO but not used or interpreted by Communications Server. Personal Communications may use it to store the LOCAL_LU_ALIAS name specified in the Define CPI-C Side Information configuration definition.

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_SYM_DEST_NAME

AP_INVALID_LENGTH

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because the node is stopping, the Program returns the following parameter:
primary_rc
AP_NODE_STOPPING
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR