You are here: SwitchKit® Development Environment Programmer’s Guide > 8 Utility Functions > sk_extractExtendedICBFromChannelReleasedWithData()
sk_extractExtendedICBFromChannelReleasedWithData()
The sk_extractExtendedICBFromChannelReleasedWithData() function is used to extract ICBSubType, ICBLength & ICBData from an SK_ChannelReleasedWithData message independent of the ICBType (Data Type or Extended Data Type). This function compensates for the fact that the ICBSubType and ICBLength fields may be two bytes each for messages with the Extended Data Type ICB or one byte each for all other ICB’s. All developers extracting information from an SK_ChannelReleaseWithData message should use this function rather than using the fields defined in the C Structure. Using this function prevents any future incompatibilities with other types of ICB data stored in this message. This function is also available as skts_extractExtendedICBFromChannelReleasedWithData().
Syntax
sk_extractExtendedICBFromChannelReleasedWithData(int* xtICBSubtype,int* xtICBLength,UBYTE** xtICBData, XL_ChannelReleasedWithData* crwdMsg)
Threadsafe Syntax
int skts_extractExtendedICBFromChannelReleasedWithData( int* xtICBSubtype, int* xtICBLength, UBYTE** xtICBData, XL_ChannelReleasedWithData* crwdMsg);
Parameters
The function parameters are shown in the table below.
|
Argument |
Description |
|---|---|
|
xtICBSubtype |
ICBSubtype value will be returned in this output argument. |
|
xtICBLength |
ICBLength will be returned in this output argument. |
|
xtICBData |
A pointer to the ICBData will be returned in this output argument. |
|
crwdMsg |
The ChannelReleasedWith Data message from which the above- mentioned output is to be extracted. |
Return Value
The return value for this function is always:
TRUE(1)