|
CCgetxparm
|   |
|
CCgetxparm
| |
Synopsis:
CCgetxparm(port, channel, parmId, &pVar[,connectionless_flag])
Arguments:
port – The logical E1/T1 port number.
channel – The channel number.
parmId - The Feature detail parameter ID
pVar – Pointer to a variable to hold the return value
[connectionless_flag] – If this flag is set then the details are retrieved from the port specific FEATURE_DETAIL_XPAMRS structure and the channel is ignored.
Description: This function maps to the following Aculab function:
ACU_ERR call_feature_details (FEATURE_DETAIL_XPARMS* feature_detailsp);
This function allows the retrieval of supplementary service information which may arrive at different stages during the lifetime of a call. After a call to CCgetparm() if the CP_FEATURE_INFORMATION field is set then this indicates that there are some feature details that can be retrieved through a call to CCgetxparm().
Note that this function is also used to retrieve connectionless feature information which is retrieved through a call to CCgetcnctless(port). To retrieve the connectionless feature details then the [connectionless_flag] should be set to 1 and the channel set to 0.
The list of ParmID constants (as defined in ACULAB.INC) and their mapping to the FEATURE_DETAIL_XPARMS structure is shown in the table below:
|
parmID |
Structure and Field it maps to: |
Field type |
|
FP_MSG_CONTROL |
get_feature_parm.message_control |
PT_INT |
|
FP_UUI_COMMAND |
get_feature_parm.feature.uui.command |
PT_INT |
|
FP_UUI_REQUEST |
get_feature_parm.feature.uui.request |
PT_UINT |
|
FP_UUI_TX_RESPONSE |
get_feature_parm.feature.uui.tx_response |
PT_INT |
|
FP_UUI_RX_RESPONSE |
get_feature_parm.feature.uui.rx_response |
PT_INT |
|
FP_UUI_CONTROL |
get_feature_parm.feature.uui.control |
PT_CHAR |
|
FP_UUI_FLOW_CONTROL |
get_feature_parm.feature.uui.flow_control |
PT_CHAR |
|
FP_UUI_PROTOCOL |
get_feature_parm.feature.uui.protocol |
PT_UCHAR |
|
FP_UUI_MORE |
get_feature_parm.feature.uui.more |
PT_CHAR |
|
FP_UUI_LENGTH |
get_feature_parm.feature.uui.length |
PT_UCHAR |
|
FP_UUI_DATA |
get_feature_parm.feature.uui.data |
PT_STRING |
|
FP_FAC_COMMAND |
get_feature_parm.feature.facility.command |
PT_INT |
|
FP_FAC_CONTROL |
get_feature_parm.feature.facility.control |
PT_UCHAR |
|
FP_FAC_LENGTH |
get_feature_parm.feature.facility.length |
PT_UCHAR |
|
FP_FAC_DATA |
get_feature_parm.feature.facility.data |
PT_STRING |
|
FP_FAC_DESTINATION_ADDR |
get_feature_parm.feature.facility.destination_addr |
PT_STRING |
|
FP_FAC_ORIGINATING_ADDR |
get_feature_parm.feature.facility.originating_addr |
PT_STRING |
|
FP_FAC_DEST_SUBADDR |
get_feature_parm.feature.facility.dest_subaddr |
PT_STRING |
|
FP_FAC_DEST_NUMBERING_TYPE |
get_feature_parm.feature.facility.dest_numbering_type |
PT_UCHAR |
|
FP_FAC_DEST_NUMBERING_PLAN |
get_feature_parm.feature.facility.dest_numbering_plan |
PT_UCHAR |
|
FP_FAC_ORIG_NUMBERING_TYPE |
get_feature_parm.feature.facility.orig_numbering_type |
PT_UCHAR |
|
FP_FAC_ORIG_NUMBERING_PLAN |
get_feature_parm.feature.facility.orig_numbering_plan |
PT_UCHAR |
|
FP_FAC_ORIG_NUMBERING_PRESENTATION |
get_feature_parm.feature.facility.orig_numbering_presentation |
PT_UCHAR |
|
FP_FAC_ORIG_NUMBERING_SCREENING |
get_feature_parm.feature.facility.orig_numbering_screening |
PT_UCHAR |
|
FP_FAC_MORE |
get_feature_parm.feature.facility.more |
PT_UCHAR |
|
FP_DIV_DIVERTING_REASON |
get_feature_parm.feature.diversion.diverting_reason |
PT_UCHAR |
|
FP_DIV_DIVERTING_COUNTER |
get_feature_parm.feature.diversion.diverting_counter |
PT_UCHAR |
|
FP_DIV_DIVERTING_TO_ADDR |
get_feature_parm.feature.diversion.diverting_to_addr |
PT_STRING |
|
FP_DIV_DIVERTING_FROM_ADDR |
get_feature_parm.feature.diversion.diverting_from_addr |
PT_STRING |
|
FP_DIV_ORIGINAL_CALLED_ADDR |
get_feature_parm.feature.diversion.original_called_addr |
PT_STRING |
|
FP_DIV_DIVERTING_FROM_TYPE |
get_feature_parm.feature.diversion.diverting_from_type |
PT_UCHAR |
|
FP_DIV_DIVERTING_FROM_PLAN |
get_feature_parm.feature.diversion.diverting_from_plan |
PT_UCHAR |
|
FP_DIV_DIVERTING_FROM_PRESENTATION |
get_feature_parm.feature.diversion.diverting_from_presentation |
PT_UCHAR |
|
FP_DIV_DIVERTING_FROM_SCREENING |
get_feature_parm.feature.diversion.diverting_from_screening |
PT_UCHAR |
|
FP_DIV_DIVERTING_INDICATOR |
get_feature_parm.feature.diversion.diverting_indicator |
PT_UCHAR |
|
FP_DIV_ORIGINAL_DIVERTING_REASON |
get_feature_parm.feature.diversion.original_diverting_reason |
PT_UCHAR |
|
FP_DIV_DIVERTING_TO_TYPE |
get_feature_parm.feature.diversion.diverting_to_type |
PT_UCHAR |
|
FP_DIV_DIVERTING_TO_PLAN |
get_feature_parm.feature.diversion.diverting_to_plan |
PT_UCHAR |
|
FP_DIV_DIVERTING_TO_INT_NW_INDICATOR |
get_feature_parm.feature.diversion.diverting_to_int_nw_indicator |
PT_UCHAR |
|
FP_DIV_ORIGINAL_CALLED_TYPE |
get_feature_parm.feature.diversion.original_called_type |
PT_UCHAR |
|
FP_DIV_ORIGINAL_CALLED_PLAN |
get_feature_parm.feature.diversion.original_called_plan |
PT_UCHAR |
|
FP_DIV_ORIGINAL_CALLED_PRESENTATION |
get_feature_parm.feature.diversion.original_called_presentation |
PT_UCHAR |
|
FP_DIV_OPERATION |
get_feature_parm.feature.diversion.operation |
PT_INT |
|
FP_DIV_OPERATION_TYPE |
get_feature_parm.feature.diversion.operation_type |
PT_INT |
|
FP_DIV_ERROR |
get_feature_parm.feature.diversion.error |
PT_INT |
|
FP_HOLD_COMMAND |
get_feature_parm.feature.hold.command |
PT_INT |
|
FP_HOLD_CAUSE |
get_feature_parm.feature.hold.cause |
PT_INT |
|
FP_HOLD_Q931_TS |
get_feature_parm.feature.hold.unique_xparms.sig_q931.ts |
PT_INT |
|
FP_HOLD_Q931_RAW |
get_feature_parm.feature.hold.unique_xparms.sig_q931.raw |
PT_INT |
|
FP_HOLD_Q931_DISPLAY |
get_feature_parm.feature.hold.unique_xparms.sig_q931.display |
PT_HEXSTR |
|
FP_XFER_CONTROL |
get_feature_parm.feature.transfer.control |
PT_CHAR |
|
FP_XFER_Q931_OPERATION |
get_feature_parm.feature.transfer.unique_xparms.sig_q931.operation |
PT_INT |
|
FP_XFER_Q931_OPERATION_TYPE |
get_feature_parm.feature.transfer.unique_xparms.sig_q931.operation_type |
PT_INT |
|
FP_XFER_Q931_ERROR |
get_feature_parm.feature.transfer.unique_xparms.sig_q931.error |
PT_INT |
|
FP_XFER_Q931_ETS_LINKID |
get_feature_parm.feature.transfer.unique_xparms.sig_q931.specific.ets.LinkID |
PT_INT |
|
FP_NSTD_ID_TYPE |
get_feature_parm.feature.non_standard.id_type |
PT_INT |
|
FP_NSTD_LENGTH |
get_feature_parm.feature.non_standard.length |
PT_INT |
|
FP_NSTD_DATA |
get_feature_parm.feature.non_standard.data |
PT_STRING |
|
FP_NSTD_H221_ID_CC |
get_feature_parm.feature.non_standard.id.h221_id.cc |
PT_UINT |
|
FP_NSTD_H221_ID_EXT |
get_feature_parm.feature.non_standard.id.h221_id.ext |
PT_UINT |
|
FP_NSTD_H221_ID_CODE |
get_feature_parm.feature.non_standard.id.h221_id.code |
PT_UINT |
|
FP_NSTD_OBJECT_ID_LENGTH |
get_feature_parm.feature.non_standard.id.object_id.length |
PT_INT |
|
FP_NSTD_OBJECT_ID_ID |
get_feature_parm.feature.non_standard.id.object_id.id |
PT_STRING |
|
FP_RAW_LENGTH |
get_feature_parm.feature.raw_data.length |
PT_INT |
|
FP_RAW_DATA |
get_feature_parm.feature.raw_data.data |
PT_STRING |
|
FP_RAW_MORE |
get_feature_parm.feature.raw_data.more |
PT_UCHAR |
Returns: This function returns 0 upon success or a negative error code.