Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 6 of 11 in this chapter) Version

TCAPGetComp

Description

Extracts a specific component and, optionally, its associated parameter(s) from a TCAP transaction data message received through TCAPRetrieveMessage.

Prototype

DWORD TCAPGetComp (U8 *pMessage,
U8 index,
TcapComp *pComp,
U16 *pParamLen,
U8 *pParamBuf )
pMessage Address of the caller's message buffer containing a message of type TCAP_EVENT_DAT_IND that was previously received through TCAPRetrieveMessage.
index Index of the component being retrieved; valid range is 0 to (TcapTransEvent.numComps - 1), where TcapTransEvent is the event structure associated with this message that was returned by TCAPRetrieveMessage.
pComp Address of the caller's TcapComp area where the component body is returned.
pParamLen On input, this field should be set to the maximum number of bytes of parameters to be copied into caller's parameter buffer. On return, this field will be set to the actual number of bytes of parameters copied to the caller's parameter buffer.
pParamBuf Address of the caller's parameter buffer where parameters belonging to this component are returned to caller (size of this buffer is passed initially in the pParamLen parameter).

Return Values

TCAP_SUCCESS
TCAP_OVERFLOW
The caller's parameter buffer was not large enough to hold the parameters for this component.
TCAP_INDEX
The specified component index does not exist in the message buffer passed by the caller, or it was not a valid TCAP transaction message in the buffer.

Details

The caller must preserve the contents of the message buffer between the call to TCAPRetrieveMessage that returned the message and the last call to TCAPGetComp to retrieve the last component. Once the last call to TCAPGetComp returns, the message buffer may be released or reused.
If the caller does not expect any parameters with this component, then NULL pointers may be specified for the pParamLen and pParamBuf arguments.
If the number of bytes of component parameters belonging to the specified component exceeds the size of the caller's parameter buffer (as specified by the input value of the pParamLen argument), then:

Only the first (*pParamLen) bytes of parameters are copied to the caller's parameter buffer (if pParamLen and pParamBuf are not NULL);

The actual number of bytes needed to contain the parameters is returned to the caller in the pParamLen argument (if pParamLen is not NULL); and

The return value of the function is TCAP_OVERFLOW.

Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 6 of 11 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Copyright © 2002, NMS Communications Corporation. All rights reserved.