(v13) D_IP_GET_CHANNEL_CLASS_DESCRIPTIONS
This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core
D_IP_GET_CHANNEL_CLASS_DESCRIPTIONS Selector
Parameters: GetChannelClassesParam *param
Call type: Repeated single‐call
Call to enumerate descriptions of the channels supported by this plugin.
typedef struct getChannelClassesParam { int32 version ;
int32 sequenceNumber ; ChannelClassDescription *channelClassDescription ; int32 found ;
} GetChannelClassesParam ;
version
The version
field should be ignored.
sequenceNumber
On the first call to this selector, the RIP sets sequenceNumber
to 1. It is incremented on each call to allow the plugin to keep track of successive requests.
channelClassDescription
The plugin fills in this structure for each channel class implemented by the plugin.
Note: The pointer points to a structure assigned by the RIP, and the plugin should fill in the contents, not set the pointer.
found
Each time the plugin fills in a channelClassDescription
, it should set this to a non‐zero value. When it has finished enumerating the descriptions it should set this to zero.
Note: This field should be set to zero on the call after the last description is returned, not on the last one.