Difference between revisions of "Truxton etl set expander version"

From truxwiki.com
Jump to navigation Jump to search
 
Line 1: Line 1:
 
The optional version number of your ETL process.
 
The optional version number of your ETL process.
It will be written to the <code>Version</code> column of the <code>[[ExpandedFile Table | ExpandedFile]]</code> table.
+
It will be written to the <code>[Version]</code> column of the <code><nowiki>[</nowiki>[[ExpandedFile Table|ExpandedFile]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void etl_set_expander_version( uint64_t handle, uint64_t application_version );
 
void etl_set_expander_version( uint64_t handle, uint64_t application_version );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
 
==<code>etl_handle</code>==
 
==<code>etl_handle</code>==
 
 
The handle created by the [[truxton_etl_create]] call.
 
The handle created by the [[truxton_etl_create]] call.
  
Line 20: Line 19:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="16">
+
<source lang="C" highlight="14">
 
#include <TruxtonCAPI.h>
 
#include <TruxtonCAPI.h>
  
Line 26: Line 25:
 
{
 
{
 
     char file_id[ 65 ];
 
     char file_id[ 65 ];
 
    int exit_loop = 0;
 
  
 
     uint64_t message = 0;
 
     uint64_t message = 0;
Line 38: Line 35:
 
     truxton_etl_set_expander_version( app, 0 );
 
     truxton_etl_set_expander_version( app, 0 );
  
     while( exit_loop == 0 )
+
    // Pause here until we get a message from the "SampleC" message queue
 +
    message = truxton_etl_get_message( app );
 +
 
 +
     while( message != 0 )
 
     {
 
     {
         message = truxton_etl_get_message( app );
+
         // Do something with the message
  
         if ( message != 0 )
+
         memset( file_id, 0x00, sizeof( file_id ) );
         {
+
         truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
            // Do something with the message
 
  
            memset( file_id, 0x00, sizeof( file_id ) );
+
        printf( "Received file id %s\n", file_id );
            truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
 
  
            printf( "Received file id %s\n", file_id );
+
        truxton_message_destroy( message );
  
            truxton_message_destroy( message );
+
        // Pause here until we get another message from the "SampleC" message queue
         }
+
         message = truxton_etl_get_message( app );
        else
 
        {
 
            exit_loop = 1;
 
        }
 
 
     }
 
     }
  
 
     truxton_etl_destroy( app );
 
     truxton_etl_destroy( app );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 03:52, 5 December 2020

The optional version number of your ETL process. It will be written to the [Version] column of the [ExpandedFile] table.

Syntax

void etl_set_expander_version( uint64_t handle, uint64_t application_version );

Parameters

etl_handle

The handle created by the truxton_etl_create call.

application_version

A value to represent the current version of your ETL process. Setting the version number to zero will cause Truxton to use the version information for your executable.

Remarks

If you do not set the version number, Truxton will use a packed version number based on the information in the version resource of your executable.

Sample

#include <TruxtonCAPI.h>

void main( void )
{
    char file_id[ 65 ];

    uint64_t message = 0;
    uint64_t app = truxton_etl_create();

    truxton_etl_set_application_name( app, "Sample C ETL" );
    truxton_etl_set_stage_number( app, 42 );
    truxton_etl_set_queue_name( app, "SampleC" );
    truxton_etl_set_expander_identifier( app, 0x05FC0BF6A57726A0 );
    truxton_etl_set_expander_version( app, 0 );

    // Pause here until we get a message from the "SampleC" message queue
    message = truxton_etl_get_message( app );

    while( message != 0 )
    {
        // Do something with the message

        memset( file_id, 0x00, sizeof( file_id ) );
        truxton_message_get_file_id( message, file_id, sizeof( file_id ) );

        printf( "Received file id %s\n", file_id );

        truxton_message_destroy( message );

        // Pause here until we get another message from the "SampleC" message queue
        message = truxton_etl_get_message( app );
    }

    truxton_etl_destroy( app );
}