QUERY_CPIC_SIDE_INFO

This verb returns the side information entry for a given symbolic destination name. The information is returned as a list. To obtain a specific side information entry, or a specific chunk of entries, the sym_dest_name field should be set. Otherwise this field should be set to all zeros.

VCB Structure

typedef struct query_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   *buf_ptr;             /* pointer to buffer          */
   unsigned long   buf_size;             /* buffer size                */
   unsigned long   total_buf_size;       /* total buffer size required */
   unsigned short  num_entries;          /* number of entries          */
   unsigned short  total_num_entries;    /* total number of entries    */
   unsigned char   list_options;         /* listing options            */
   unsigned char   reserv3;              /* reserved                   */
   unsigned char   sym_dest_name[8];     /* Symbolic destination name  */
} QUERY_CPIC_SIDE_INFO;
typedef struct cpic_side_info_data
{
   unsigned short  overlay_size;         /* size of this entry         */
   unsigned char   sym_dest_name[8];     /* Symbolic destination name  */
   unsigned char   reserv1[2];           /* reserved                   */
   CPIC_SIDE_INFO_DEF_DATA  def_data;
} CPIC_SIDE_INFO_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;
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;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_CPIC_SIDE_INFO
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
buf_ptr
Pointer to a buffer into which list information can be written.
buf_size
Size of buffer supplied. The data returned will not exceed this size.
num_entries
Maximum number of entries to return. The number of entries will not exceed this value. A value of zero means no limit.
list_options
This indicates what should be returned in the list information. The sym_dest_name specified (see below) represents an index value that is used to specify the starting point of the actual information to be returned:
AP_FIRST_IN_LIST
The index value is ignored and the returned list starts from the first entry in the list.
AP_LIST_FROM_NEXT
The returned list starts from the next entry in the list after the one specified by the supplied index value.
AP_LIST_INCLUSIVE
The returned list starts from the entry specified by the index value.
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.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information requested. This may be higher than buf_size.
num_entries
Number of entries actually returned.
total_num_entries
Total number of entries that could have been returned. This may be higher than num_entries.
cpic_side_info_data.overlay_size
The number of bytes in this entry, and hence the offset to the next entry returned (if any).
cpic_side_info_data.sym_dest_name
Symbolic destination name for the returned side information entry.
cpic_side_info_data.def_data
Defined CPI-C side information as supplied on DEFINE_CPIC_SIDE_INFO verb.
Note:
CPIC calls may change the side information returned on this verb after the DEFINE_CPIC_SIDE_INFO has been processed by Personal Communications or Communications Server.
If the verb does not execute because of a state error, the Program returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_INVALID_SYM_DEST_NAME
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