Difference between revisions of "Truxton message set dont route"

From truxwiki.com
Jump to navigation Jump to search
Line 2: Line 2:
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_message_set_dont_route( uint64_t message_handle, uint32_t route_or_not_to_route );
 
void truxton_message_set_dont_route( uint64_t message_handle, uint32_t route_or_not_to_route );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 16: Line 16:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
 
void do_not_route(uint64_t message)
 
void do_not_route(uint64_t message)
 
{
 
{
 
   truxton_message_set_dont_route( message, 1);
 
   truxton_message_set_dont_route( message, 1);
 
}
 
}
</syntaxhighlight>
+
</source>

Revision as of 18:28, 18 January 2021

Disables the routing of a message.

Syntax

void truxton_message_set_dont_route( uint64_t message_handle, uint32_t route_or_not_to_route );

Parameters

message_handle

The handle to a message created by the truxton_message_create call.

route_or_not_to_route

That is the question. Passing zero will allow the message to be routed. A non-zero value will prevent the message from being routed.

Sample

void do_not_route(uint64_t message)
{
   truxton_message_set_dont_route( message, 1);
}