Truxton etl get description

This retrieves the description of the ETL application.

Syntax

void truxton_etl_get_description( uint64_t etl_handle, char * destination_string, size_t maximum_size );

Parameters

etl_handle

The handle created by the truxton_etl_create call.

destination_string

The string buffer where the description will go.

maximum_size

The size of the destination_string buffer. The maximum number of characters written to the buffer will be maximum_size minus one to leave room for the null terminator.

Remarks

This name was set using the truxton_etl_set_description() function.

Sample

#include <TruxtonCAPI.h>

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

    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_description( app, "A sample of how to write an ETL" );
    truxton_etl_get_description( app, description, sizeof(description) );

    // 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 );
}