crewID/libfreefare
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation.

Browse source 
Add a note about freefare_get_tags() invalidating previously found targets.
This commit is contained in:
Romain Tartiere 2010-04-26 11:09:04 +00:00
parent 1ea30f37bb
commit a0da16bf65
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
libfreefare/freefare.3
View file

@ -78,14 +78,14 @@ returns a NULL-terminated list of
.Vt MifareTag .Vt MifareTag
present on present on
.Vt device . .Vt device .
This list has to be freed after usage by either This list has to be freed after usage by either:
.Bl -hyphen .Bl -hyphen
.It .It
Calling the calling the
.Fn freefare_free_tags .Fn freefare_free_tags
function. All tags in the list are automatically freed; function. All tags in the list are automatically freed;
.It .It
Calling the calling the
.Fn freefare_free_tag .Fn freefare_free_tag
function to free each tag in the list individually, and freeing the list itself function to free each tag in the list individually, and freeing the list itself
using the using the
@ -93,6 +93,13 @@ using the
function. function.
.El .El
.Pp .Pp
Because of the nature of the target detection process, any previously detected
target will be in an inconsistent state after a call to
.Fn freefare_get_tags .
It is the programmer's responsibility to free these targets before calling the
.Fn freefare_get_tags
function.
.Pp
Information about a given Information about a given
.Vt MifareTag .Vt MifareTag
can be gathered using the can be gathered using the