IAnt ChannelInclude Exclude List Add Channel Method
Add the given channel ID to the channel's inclusion/exclusion list.
The channelID is then included or excluded from the wild card search depending on how the list is configured.
Throws exception if listIndex > 3.
Definition
Namespace: SmallEarthTech.AntRadioInterface
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 5.0.3+bee07ae1f518f90000e3a8eef95ac61052778db9
True on success. Note: Always returns true with a response time of 0
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 5.0.3+bee07ae1f518f90000e3a8eef95ac61052778db9
C#
bool IncludeExcludeListAddChannel(
ChannelId channelId,
byte listIndex,
uint responseWaitTime
)VB
Function IncludeExcludeListAddChannel (
channelId As ChannelId,
listIndex As Byte,
responseWaitTime As UInteger
) As BooleanC++
bool IncludeExcludeListAddChannel(
ChannelId^ channelId,
unsigned char listIndex,
unsigned int responseWaitTime
)F#
abstract IncludeExcludeListAddChannel :
channelId : ChannelId *
listIndex : byte *
responseWaitTime : uint32 -> bool Parameters
- channelId ChannelId
- Channel ID assigned to a device
- listIndex Byte
- position in inclusion/exclusion list to add channelID at (Max size of list is 4)
- responseWaitTime UInt32
- Time to wait for device success response
Return Value
BooleanTrue on success. Note: Always returns true with a response time of 0