|
CCgetparm
|   |
|
CCgetparm
| |
Synopsis:
CCgetparm(port, channel, parmId, &pVar)
Arguments:
port – The logical E1/T1 port number.
channel – The channel number.
ParmID - The ID of the parameter to get
pVar - Pointer to a variable to hold the returned parameter value.
Description: This function maps to the following Aculab function:
ACU_ERR call_details(DETAIL_XPARMS *detailsp);
It allows for various parameters to be obtained relating to the current call. The ParmID is a unique identifier that maps to one of the fields from the DETAIL_XPARMS structure or the DETAIL_XPARMS.unique_xparms structure returned by the call_details() function call.
For example to obtain the destination_addr and originating_addr fields from DETAIL_XPARMS structure, one would have som,ething like the following:
var DID:64,CLID:64;
CCgetparm(port,chan,CP_DESTINATION_ADDR,&DID);
CCgetparm(port,chan,CP_ORIGINATING_ADDR,&CLID);
The list of ParmID constants (as defined in ACULAB.INC) and their mapping to the DETAIL_XPARMS structure is shown in the table below:
|
parmID |
Structure and Field it maps to: |
Field type |
|
CP_VALID |
detail_xparms.valid |
PT_INT |
|
CP_STREAM |
detail_xparms.stream |
PT_INT |
|
CP_TS |
detail_xparms.ts |
PT_INT |
|
CP_CALLTYPE |
detail_xparms.calltype |
PT_INT |
|
CP_SENDING_COMPLETE |
detail_xparms.sending_complete |
PT_INT |
|
CP_DESTINATION_ADDR |
detail_xparms.destination_addr |
PT_STRING |
|
CP_ORIGINATING_ADDR |
detail_xparms.originating_addr |
PT_STRING |
|
CP_CONNECTED_ADDR |
detail_xparms.connected_addr |
PT_STRING |
|
CP_FEATURE_INFORMATION |
detail_xparms.feature_information |
PT_ULONG |
|
CP_Q931_SERVICE_OCTET |
detail_xparms.unique_xparms.sig_q931.service_octet |
PT_UCHAR |
|
CP_Q931_ADD_INFO_OCTET |
detail_xparms.unique_xparms.sig_q931.add_info_octet |
PT_UCHAR |
|
CP_Q931_DEST_NUMBERING_TYPE |
detail_xparms.unique_xparms.sig_q931.dest_numbering_type |
PT_UCHAR |
|
CP_Q931_DEST_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_q931.dest_numbering_plan |
PT_UCHAR |
|
CP_Q931_BEARER |
detail_xparms.unique_xparms.sig_q931.bearer.ie |
PT_HEXSTR |
|
CP_Q931_BEARER_LASTMSG |
detail_xparms.unique_xparms.sig_q931.bearer.last_msg |
PT_UCHAR |
|
CP_Q931_ORIG_NUMBERING_TYPE |
detail_xparms.unique_xparms.sig_q931.orig_numbering_type |
PT_UCHAR |
|
CP_Q931_ORIG_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_q931.orig_numbering_plan |
PT_UCHAR |
|
CP_Q931_ORIG_NUMBERING_PRESENTATION |
detail_xparms.unique_xparms.sig_q931.orig_numbering_presentation |
PT_UCHAR |
|
CP_Q931_ORIG_NUMBERING_SCREENING |
detail_xparms.unique_xparms.sig_q931.orig_numbering_screening |
PT_UCHAR |
|
CP_Q931_CONN_NUMBERING_TYPE |
detail_xparms.unique_xparms.sig_q931.conn_numbering_type |
PT_UCHAR |
|
CP_Q931_CONN_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_q931.conn_numbering_plan |
PT_UCHAR |
|
CP_Q931_CONN_NUMBERING_PRESENTATION |
detail_xparms.unique_xparms.sig_q931.conn_numbering_presentation |
PT_UCHAR |
|
CP_Q931_CONN_NUMBERING_SCREENING |
detail_xparms.unique_xparms.sig_q931.conn_numbering_screening |
PT_UCHAR |
|
CP_Q931_DEST_SUBADDR |
detail_xparms.unique_xparms.sig_q931.dest_subaddr |
PT_HEXSTR |
|
CP_Q931_ORIG_SUBADDR |
detail_xparms.unique_xparms.sig_q931.orig_subaddr |
PT_HEXSTR |
|
CP_Q931_HILAYER |
detail_xparms.unique_xparms.sig_q931.hilayer.ie |
PT_HEXSTR |
|
CP_Q931_HILAYER_LASTMSG |
detail_xparms.unique_xparms.sig_q931.hilayer.last_msg |
PT_UCHAR |
|
CP_Q931_LOLAYER |
detail_xparms.unique_xparms.sig_q931.lolayer.ie |
PT_HEXSTR |
|
CP_Q931_LOLAYER_LASTMSG |
detail_xparms.unique_xparms.sig_q931.lolayer.last_msg |
PT_UCHAR |
|
CP_Q931_PROGRESS_INDICATOR |
detail_xparms.unique_xparms.sig_q931.progress_indicator.ie |
PT_HEXSTR |
|
CP_Q931_PROGRESS_LASTMSG |
detail_xparms.unique_xparms.sig_q931.progress_indicator.last_msg |
PT_UCHAR |
|
CP_Q931_NOTIFY_INDICATOR |
detail_xparms.unique_xparms.sig_q931.notify_indicator.ie |
PT_HEXSTR |
|
CP_Q931_NOTIFY_LASTMSG |
detail_xparms.unique_xparms.sig_q931.notify_indicator.last_msg |
PT_UCHAR |
|
CP_Q931_KEYPAD |
detail_xparms.unique_xparms.sig_q931.keypad.ie |
PT_HEXSTR |
|
CP_Q931_KEYPAD_LASTMSG |
detail_xparms.unique_xparms.sig_q931.keypad.last_msg |
PT_UCHAR |
|
CP_Q931_DISPLAY |
detail_xparms.unique_xparms.sig_q931.display.ie |
PT_HEXSTR |
|
CP_Q931_DISPLAY_LASTMSG |
detail_xparms.unique_xparms.sig_q931.display.last_msg |
PT_UCHAR |
|
CP_Q931_SLOTMAP |
detail_xparms.unique_xparms.sig_q931.slotmap |
PT_LONG |
|
CP_Q931_EP_USID |
detail_xparms.unique_xparms.sig_q931.endpoint_id.usid |
PT_UCHAR |
|
CP_Q931_EP_TID |
detail_xparms.unique_xparms.sig_q931.endpoint_id.tid |
PT_UCHAR |
|
CP_Q931_EP_INTERPRETER |
detail_xparms.unique_xparms.sig_q931.endpoint_id.interpreter |
PT_UCHAR |
|
CP_Q931_CAUSE |
detail_xparms.unique_xparms.sig_q931.cause.ie |
PT_HEXSTR |
|
CP_Q931_CAUSE_LASTMSG |
detail_xparms.unique_xparms.sig_q931.cause.last_msg |
PT_UCHAR |
|
CP_Q931_ADD_ORIG_ADDR |
detail_xparms.unique_xparms.sig_q931.additional_orig_addr |
PT_HEXSTR |
|
CP_Q931_ADD_ORIG_NUMBERING_TYPE |
detail_xparms.unique_xparms.sig_q931.add_orig_numbering_type |
PT_UCHAR |
|
CP_Q931_ADD_ORIG_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_q931.add_orig_numbering_plan |
PT_UCHAR |
|
CP_Q931_ADD_ORIG_NUMBERING_PRESENTATION |
detail_xparms.unique_xparms.sig_q931.add_orig_numbering_presentation |
PT_UCHAR |
|
CP_Q931_ADD_ORIG_NUMBERING_SCREENING |
detail_xparms.unique_xparms.sig_q931.add_orig_numbering_screening |
PT_UCHAR |
|
CP_Q931_OMIT_CALLING_PARTY_IE |
detail_xparms.unique_xparms.sig_q931.omit_calling_party_ie |
PT_UCHAR |
|
CP_Q931_CALL_REF |
detail_xparms.unique_xparms.sig_q931.call_ref_value |
PT_ULONG |
|
CP_DASS_SIC1 |
detail_xparms.unique_xparms.sig_dass.sic1 |
PT_UCHAR |
|
CP_DASS_SIC2 |
detail_xparms.unique_xparms.sig_dass.sic2 |
PT_UCHAR |
|
CP_DPNSS_SIC1 |
detail_xparms.unique_xparms.sig_dpnss.sic1 |
PT_UCHAR |
|
CP_DPNSS_SIC2 |
detail_xparms.unique_xparms.sig_dpnss.sic2 |
PT_UCHAR |
|
CP_DPNSS_CLC |
detail_xparms.unique_xparms.sig_dpnss.clc |
PT_STRING |
|
CP_CAS_CATEGORY |
detail_xparms.unique_xparms.sig_cas.category |
PT_UCHAR |
|
CP_ISUP_SERVICE_OCTET |
detail_xparms.unique_xparms.sig_isup.service_octet |
PT_UCHAR |
|
CP_ISUP_ADD_INFO_OCTET |
detail_xparms.unique_xparms.sig_isup.add_info_octet |
PT_UCHAR |
|
CP_ISUP_DEST_NATUREOF_ADDR |
detail_xparms.unique_xparms.sig_isup.dest_natureof_addr |
PT_UCHAR |
|
CP_ISUP_DEST_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_isup.dest_numbering_plan |
PT_UCHAR |
|
CP_ISUP_BEARER |
detail_xparms.unique_xparms.sig_isup.bearer.ie |
PT_HEXSTR |
|
CP_ISUP_BEARER_LASTMSG |
detail_xparms.unique_xparms.sig_isup.bearer.last_msg |
PT_UCHAR |
|
CP_ISUP_ORIG_NATUREOF_ADDR |
detail_xparms.unique_xparms.sig_isup.orig_natureof_addr |
PT_UCHAR |
|
CP_ISUP_ORIG_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_isup.orig_numbering_plan |
PT_UCHAR |
|
CP_ISUP_ORIG_NUMBERING_PRESENTATION |
detail_xparms.unique_xparms.sig_isup.orig_numbering_presentation |
PT_UCHAR |
|
CP_ISUP_ORIG_NUMBERING_SCREENING |
detail_xparms.unique_xparms.sig_isup.orig_numbering_screening |
PT_UCHAR |
|
CP_ISUP_CONN_NATUREOF_ADDR |
detail_xparms.unique_xparms.sig_isup.conn_natureof_addr |
PT_UCHAR |
|
CP_ISUP_CONN_NUMBERING_PLAN |
detail_xparms.unique_xparms.sig_isup.conn_numbering_plan |
PT_UCHAR |
|
CP_ISUP_CONN_NUMBERING_PRESENTATION |
detail_xparms.unique_xparms.sig_isup.conn_numbering_presentation |
PT_UCHAR |
|
CP_ISUP_CONN_NUMBERING_SCREENING |
detail_xparms.unique_xparms.sig_isup.conn_numbering_screening |
PT_UCHAR |
|
CP_ISUP_CONN_NUMBER_REQ |
detail_xparms.unique_xparms.sig_isup.conn_number_req |
PT_UCHAR |
|
CP_ISUP_ORIG_CATEGORY |
detail_xparms.unique_xparms.sig_isup.orig_category |
PT_UCHAR |
|
CP_ISUP_ORIG_NUMBER_INCOMPLETE |
detail_xparms.unique_xparms.sig_isup.orig_number_incomplete |
PT_UCHAR |
|
CP_ISUP_DEST_SUBADDR |
detail_xparms.unique_xparms.sig_isup.dest_subaddr |
PT_HEXSTR |
|
CP_ISUP_ORIG_SUBADDR |
detail_xparms.unique_xparms.sig_isup.orig_subaddr |
PT_HEXSTR |
|
CP_ISUP_HILAYER |
detail_xparms.unique_xparms.sig_isup.hilayer.ie |
PT_HEXSTR |
|
CP_ISUP_HILAYER_LASTMSG |
detail_xparms.unique_xparms.sig_isup.hilayer.last_msg |
PT_UCHAR |
|
CP_ISUP_LOLAYER |
detail_xparms.unique_xparms.sig_isup.lolayer.ie |
PT_HEXSTR |
|
CP_ISUP_LOLAYER_LASTMSG |
detail_xparms.unique_xparms.sig_isup.lolayer.last_msg |
PT_UCHAR |
|
CP_ISUP_PROGRESS_INDICATOR |
detail_xparms.unique_xparms.sig_isup.progress_indicator.ie |
PT_HEXSTR |
|
CP_ISUP_PROGRESS_LASTMSG |
detail_xparms.unique_xparms.sig_isup.progress_indicator.last_msg |
PT_UCHAR |
|
CP_ISUP_IN_BAND |
detail_xparms.unique_xparms.sig_isup.in_band |
PT_UCHAR |
|
CP_ISUP_NAT_INTER_CALL_IND |
detail_xparms.unique_xparms.sig_isup.nat_inter_call_ind |
PT_UCHAR |
|
CP_ISUP_INTERWORKING_IND |
detail_xparms.unique_xparms.sig_isup.interworking_ind |
PT_UCHAR |
|
CP_ISUP_ISDN_USERPART_IND |
detail_xparms.unique_xparms.sig_isup.isdn_userpart_ind |
PT_UCHAR |
|
CP_ISUP_ISDN_USERPART_PREF_IND |
detail_xparms.unique_xparms.sig_isup.isdn_userpart_pref_ind |
PT_UCHAR |
|
CP_ISUP_ISDN_ACCESS_IND |
detail_xparms.unique_xparms.sig_isup.isdn_access_ind |
PT_UCHAR |
|
CP_ISUP_DEST_INT_NW_IND |
detail_xparms.unique_xparms.sig_isup.dest_int_nw_ind |
PT_UCHAR |
|
CP_ISUP_CONTINUITY_CHECK_IND |
detail_xparms.unique_xparms.sig_isup.continuity_check_ind |
PT_UCHAR |
|
CP_ISUP_SATELLITE_IND |
detail_xparms.unique_xparms.sig_isup.satellite_ind |
PT_UCHAR |
|
CP_ISUP_CHARGE_IND |
detail_xparms.unique_xparms.sig_isup.charge_ind |
PT_UCHAR |
|
CP_ISUP_DEST_CATEGORY |
detail_xparms.unique_xparms.sig_isup.dest_category |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_QUAL |
detail_xparms.unique_xparms.sig_isup.add_calling_num_qualifier_ind |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_NOAI |
detail_xparms.unique_xparms.sig_isup.add_calling_num_natureof_addr |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_PLAN |
detail_xparms.unique_xparms.sig_isup.add_calling_num_plan |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_PRESENT |
detail_xparms.unique_xparms.sig_isup.add_calling_num_presentation |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_SCREEN |
detail_xparms.unique_xparms.sig_isup.add_calling_num_screening |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM_INCOMP |
detail_xparms.unique_xparms.sig_isup.add_calling_num_incomplete |
PT_UCHAR |
|
CP_ISUP_ADD_CALL_NUM |
detail_xparms.unique_xparms.sig_isup.add_calling_num |
PT_HEXSTR |
|
CP_ISUP_EXCHANGE_TYPE |
detail_xparms.unique_xparms.sig_isup.exchange_type |
PT_UCHAR |
|
CP_ISUP_COLLECT_CALL |
detail_xparms.unique_xparms.sig_isup.collect_call_request_ind |
PT_UCHAR |
|
CP_IPTEL_DEST_DISPLAY |
detail_xparms.unique_xparms.sig_iptel.destination_display_name |
PT_STRING |
|
CP_IPTEL_ORIG_DISPLAY |
detail_xparms.unique_xparms.sig_iptel.originating_display_name |
PT_STRING |
|
CP_IPTEL_CODECS |
detail_xparms.unique_xparms.sig_iptel.codecs |
PT_HEXSTR |
|
CP_IPTEL_MEDIA_TDM_ENC |
detail_xparms.unique_xparms.sig_iptel.media_settings.tdm_encoding |
PT_INT |
|
CP_IPTEL_MEDIA_ENC_GAIN |
detail_xparms.unique_xparms.sig_iptel.media_settings.encode_gain |
PT_INT |
|
CP_IPTEL_MEDIA_DEC_GAIN |
detail_xparms.unique_xparms.sig_iptel.media_settings.decode_gain |
PT_INT |
|
CP_IPTEL_MEDIA_ECHO_CANC |
detail_xparms.unique_xparms.sig_iptel.media_settings.echo_cancellation |
PT_INT |
|
CP_IPTEL_MEDIA_ECHO_SUPP |
detail_xparms.unique_xparms.sig_iptel.media_settings.echo_suppression |
PT_INT |
|
CP_IPTEL_MEDIA_ECHO_SPAN |
detail_xparms.unique_xparms.sig_iptel.media_settings.echo_span |
PT_INT |
|
CP_IPTEL_MEDIA_RTP_TOS |
detail_xparms.unique_xparms.sig_iptel.media_settings.rtp_tos |
PT_INT |
|
CP_IPTEL_MEDIA_RTCP_TOS |
detail_xparms.unique_xparms.sig_iptel.media_settings.rtcp_tos |
PT_INT |
|
CP_IPTEL_MEDIA_DTMF_DET |
detail_xparms.unique_xparms.sig_iptel.media_settings.dtmf_detector |
PT_INT |
|
CP_IPTEL_VMPRXID |
detail_xparms.unique_xparms.sig_iptel.vmprxid |
PT_HEXSTR |
|
CP_IPTEL_VMPTXID |
detail_xparms.unique_xparms.sig_iptel.vmptxid |
PT_HEXSTR |
|
CP_IPTEL_MEDIA_CALL_TYPE |
detail_xparms.unique_xparms.sig_iptel.media_call_type |
PT_STRING |
|
CP_H323_DEST_ALIAS |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.destination_alias |
PT_STRING |
|
CP_H323_ORIG_ALIAS |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.originating_alias |
PT_STRING |
|
CP_H323_H245_TUNNELING |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.h245_tunneling |
PT_INT |
|
CP_H323_FASTSTART |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.faststart |
PT_INT |
|
CP_H323_EARLY_H245 |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.early_h245 |
PT_INT |
|
CP_H323_DTMF |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.dtmf |
PT_STRING |
|
CP_H323_PROGRESS_LOC |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.progress_location |
PT_INT |
|
CP_H323_PROGRESS_DESC |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_h323.progress_description |
PT_INT |
|
CP_SIP_CONTACT_ADDR |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_sip.contact_address |
PT_STRING |
|
CP_SIP_ZERO_CONN_ADDR_HOLD |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_sip.zero_connection_address_hold |
PT_INT |
|
CP_SIP_DISABLE_REL_PROV |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_sip.disable_reliable_provisional_response |
PT_INT |
|
CP_SIP_DISABLE_EARLY_MED |
detail_xparms.unique_xparms.sig_iptel.protocol_specific.sig_sip.disable_early_media |
PT_INT |
In the previous tables the third column defines the type of value that the field will be returned as. A description of each of these types is given below:
|
PT_CHAR |
Single byte signed integer (range -127 to +127) |
|
PT_UCHAR |
Single byte unsigned integer (range (0 to 255) |
|
PT_INT |
Two byte unsigned integer (range -32767 to +32767) |
|
PT_UINT |
Two byte unsigned integer (range 0 to 65535) |
|
PT_LONG |
Four byte signed integer (range -2147483647 to +2147483647) |
|
PT_ULONG |
Four byte signed integer (range 0 to 4294967295) |
|
PT_STRING |
Literal string value |
|
PT_HEXSTR |
This is a special type where the data stored in the field is not one of the above types and is instead a multi-byte non-string field with arbitrary structure. For fields of this type the value returned by the CCgetparm() function will be in the form of a Hexadecimal string where each byte value is represented in the string by a two hexadecimal characters. See CCsetparm() for more information about HEXSTR types. |
Returns: This function returns 0 upon success or a negative error code.