From 363c01d6f887d99800499ffc2437e4fb9fae903f Mon Sep 17 00:00:00 2001 From: apio Date: Sun, 6 Nov 2022 13:58:41 +0000 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index de853d9..82314bc 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Reads the next entry from a `struct minitar` which should be the return value of This structure consists of the file metadata (in the `metadata` field), and a heap-allocated pointer to the file's contents (the `ptr` field), of size metadata.size + a NULL character, for convenience. This means you can use normal C string functions if you're expecting an ASCII file. Other kinds of files may have NULL characters before the end of the file, so you should assume the length of `ptr` is `metadata.size` and not `strlen(ptr)`. -This pointer will be freed when calling `minitar_free_entry()`, so if you're intending to use it later, copy its contents somewhere else. +This pointer will be freed when calling `minitar_free_entry()`, so if you're intending to use the file's contents later, copy them somewhere else. This function returns NULL on end-of-file (when all entries have been read).