apio/minitar
1
1
Fork 0
Code Issues Pull Requests Releases 15 Activity

docs: Update function signature of minitar_read_contents()

Browse Source
This commit is contained in:
apio 2023-01-29 22:20:15 +01:00
parent 45fbd789d6
commit 95700b6916
Signed by: apio
GPG Key ID: B8A7D06E42258954
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.md
View File

@ -45,7 +45,7 @@ Same as `minitar_find_by_name()`, but matches the full path inside the archive i
Same as `minitar_find_by_name()`, but matches the file type instead of the name. As with `minitar_find_by_name()`, this function starts searching from the current archive position and calling it in a loop until it returns -1 will find all matching entries.
### minitar_read_contents
`size_t minitar_read_contents(struct minitar* mp, struct minitar_entry* entry, char* buf, size_t max)`
`size_t minitar_read_contents(struct minitar* mp, const struct minitar_entry* entry, char* buf, size_t max)`
Reads up to `max` bytes of an entry's contents from the archive stream `mp` and stores them into `buf`.