Sam: Created page with "This retrieves the name of the ETL application. =Syntax= void truxton_etl_get_application_name( uint64_t etl_handle, char * destination_string, size_t maxim..."

2021-03-19T19:16:43Z

Created page with "This retrieves the name of the ETL application. =Syntax= <source lang="C"> void truxton_etl_get_application_name( uint64_t etl_handle, char * destination_string, size_t maxim..."

New page

This retrieves the name of the ETL application.

=Syntax=
<source lang="C">
void truxton_etl_get_application_name( uint64_t etl_handle, char * destination_string, size_t maximum_size );
</source>

=Parameters=
==<code>etl_handle</code>==
The handle created by the [[truxton_etl_create]] call.

==<code>destination_string</code>==
The string buffer where the description will go.

==<code>maximum_size</code>==
The size of the <code>destination_string</code> buffer.
The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.]

=Remarks=
This name was set using the <code>[[truxton_etl_set_application_name]]()</code> function.

=Sample=
<source lang="C" highlight="16">
#include <TruxtonCAPI.h>

void main( void )
{
char file_id[ 65 ];
char name[ 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_application_name( app, name, sizeof(name) );

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

Truxton etl get application name - Revision history

Sam: Created page with "This retrieves the name of the ETL application. =Syntax= void truxton_etl_get_application_name( uint64_t etl_handle, char * destination_string, size_t maxim..."