Truxton usb tag

From truxwiki.com
Revision as of 14:24, 1 February 2021 by Sam (talk | contribs) (Created page with "This will tag the USB device. =Syntax= <source lang="C"> void truxton_usb_tag( uint64_t usb_handle, char const * tag_name, char const * why, uint64_t origin ); </source> =Pa...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This will tag the USB device.

Syntax

void truxton_usb_tag( uint64_t usb_handle, char const * tag_name, char const * why, uint64_t origin );

Parameters

usb_handle

The handle to the USB device created by calling truxton_usb_create().

tag_name

The small bit of text that will serve as the tag. This will show up in the user interface. This parameter must match one of the values in the [Name] column of the [Tag] table. You can create tags using the truxton_create_tag API.

why

The reason why this item was tagged.

origin

What produced this tag. If an algorithm produced this tag, it should be set to 1. If you are calling this method because a human told you to, the value should be 2.

Sample

1 #define TAG_ORIGIN_AUTOMATIC (1)
2 #define TAG_ORIGIN_HUMAN     (2)
3 
4 void target_item(uint64_t usb_handle)
5 {
6    truxton_usb_tag( usb_handle, "Target", "This is the targeted item", TAG_ORIGIN_AUTOMATIC );
7 }