pnx/archived
Archived
1
0
Fork 0
Code Activity

docs/fscrawl: read does not close anymore

Browse source
This commit is contained in:
Henrik Hautakoski 2011-01-20 09:21:57 +01:00
parent 9378c5824e
commit 8be6c69e97
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/fscrawl.txt
View file

@ -42,7 +42,7 @@ Functions
`fsc_read()`:: `fsc_read()`::
Reads one entry from `fscrawl_t` and returns it. + Reads one entry from `fscrawl_t` and returns it. +
If the traversal is completed. the function closes `fscrawl_t` and returns `NULL`. If the traversal is completed `NULL` is returned.
+ +
NOTE: if you need to safe the `fs_entry` structure this function returns, make a call to `fsc_cpy()` + NOTE: if you need to safe the `fs_entry` structure this function returns, make a call to `fsc_cpy()` +
otherwise you data will be overwritten by further calls to `fsc_read()`. otherwise you data will be overwritten by further calls to `fsc_read()`.