Truxton message get truxton - Revision history

Sam at 16:40, 9 February 2021

2021-02-09T16:40:26Z

Sam: /* Sample */

2020-06-13T11:44:41Z

Sample

Sam: Created page with "This retrieves the handle to the Truxton instance handling this message object. =Syntax= uint64_t truxton_message_get_truxton( uint64_t message_han..."

2020-06-13T11:43:57Z

Created page with "This retrieves the handle to the Truxton instance handling this message object. =Syntax= <syntaxhighlight lang="C"> uint64_t truxton_message_get_truxton( uint64_t message_han..."

New page

This retrieves the handle to the Truxton instance handling this message object.

=Syntax=
<syntaxhighlight lang="C">
uint64_t truxton_message_get_truxton( uint64_t message_handle );
</syntaxhighlight>

=Parameters=
==<code>message_handle</code>==
The handle to a message created by the [[truxton_message_create]] call.

=Return value=
A non-zero value on success, zero on failure.

=Remarks=
This allows you to call any API that requires a handle to the Truxton object.
Many times, in code, you are given one type of thing but need another.
Should you find yourself in a situation where you were given file handle and you need to do something at the Truxton level, you can get the handle you need.

=Sample=

<syntaxhighlight lang="C" highlight="8">
void can_send(uint64_t message_handle)
{
if ( truxton_message_get_truxton( message_handle ) == 0 )
{
printf( "Cannot send this message.\n" );
}
else
{
printf( "Sending this message is possible.\n" );
}
}
</syntaxhighlight>

@@ Line 2: / Line 2: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 uint64_t truxton_message_get_truxton( uint64_t message_handle );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 20: / Line 20: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="3">
+<source lang="C" highlight="3">
-void can_send(uint64_t message_handle)
+void can_send( uint64_t message_handle )
+{
     if ( truxton_message_get_truxton( message_handle ) == 0 )
@@ Line 32: / Line 32: @@
+    }
+}
-</syntaxhighlight>
+</source>