ec_message_select_binding_by_group

March 26, 2020 Contributors

Name

ec_message_select_binding_by_group — Select a binding from a binding group

Synopsis

#include "binding.h"

| ec_binding_slot **ec_message_select_binding_by_group** ( | msg, |   |
|   | group); |   |

ec_message * <var class="pdparam">msg</var>;
const char * <var class="pdparam">group</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Select a binding from a binding group.

This function will randomly select one of the bindings in a group. If that binding is not local to the machine, or otherwise unplumbed, another binding will be chosen.

If no suitable binding is found, the default binding will be chosen.

Note that this function does not actually assign the message to the binding; it merely returns the binding that should be used.

Parameters

msg

the message to bind

group

the name of the binding group

Return Values

Returns the binding that was selected.