Difference between revisions of "Truxton group get status"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This gets the status for the group. =Syntax= <source lang="C"> uint64_t truxton_group_get_status( uint64_t group_handle ); </source> =Parameters= ==<code>group_handle</code>...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
This gets the status for the group.
+
This gets the [[Group Status|status]] for the group.
  
 
=Syntax=
 
=Syntax=
Line 11: Line 11:
  
 
=Return value=
 
=Return value=
The status of the group.
+
The [[Group Status|status]] of the group.
  
 
=Sample=
 
=Sample=
Line 43: Line 43:
 
}
 
}
 
</source>
 
</source>
 +
 +
The <code>PRIu64</code> in the sample code above is a standard way of [https://en.wikipedia.org/wiki/C_data_types#Printf_and_scanf_format_specifiers formatting] a 64-bit unsigned integer in C.
 +
Over the years, different compilers on different operating systems used different format specifiers for things, these <code>PRI</code> macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.

Latest revision as of 16:58, 13 April 2024

This gets the status for the group.

Syntax

uint64_t truxton_group_get_status( uint64_t group_handle );

Parameters

group_handle

The handle created by truxton_group_create() or truxton_investigation_create_group().

Return value

The status of the group.

Sample

void create_my_things(uint64_t investigation_handle)
{
    if (investigation_handle == 0)
    {
        return;
    }

    uint64_t truxton_handle = truxton_investigation_get_truxton( investigation_handle );
    uint64_t group_handle = truxton_group_create( truxton_handle );
 
    truxton_group_set_id( group_handle, "47726F75-7020-5361-6D70-6C65636F6465" );
    truxton_group_set_name( group_handle, "My Things" );
    truxton_group_set_description( group_handle, "These are my things" );
    truxton_group_set_is_default( group_handle, 1 );
    truxton_group_set_type( group_handle, GROUP_TYPE_USER );
    printf( "Status: %" PRIu64 "\n", truxton_group_get_status( group_handle ) );

    if ( truxton_group_save( group_handle ) != 0 )
    {
        char guid[MINIMUM_GUID_STRING_BUFFER_SIZE + 5];

        truxton_group_get_id( group_handle, guid, sizeof(guid) );
        truxton_investigation_set_active_group_id( investigation_handle, guid );
    }

    truxton_group_destroy( group_handle );
}

The PRIu64 in the sample code above is a standard way of formatting a 64-bit unsigned integer in C. Over the years, different compilers on different operating systems used different format specifiers for things, these PRI macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.