diff options
Diffstat (limited to 'txr.1')
| -rw-r--r-- | txr.1 | 58 |
1 files changed, 48 insertions, 10 deletions
@@ -60270,7 +60270,12 @@ bitmask arguments. For each visited entry, it calls the supplied .meta callbackfun -function, which receives five arguments. +function, which receives five arguments. If this function returns +normally, it must return either +.codn nil , +.codn t , +or an integer value in the range of the C type +.codn int . The .code ftw @@ -60290,7 +60295,9 @@ stops the traversal. (Non-integer return values behave like The .meta path -argument of the callback function gives the path of the +argument of +.meta callbackfun +gives the path of the visited filesystem object. The @@ -60334,19 +60341,50 @@ calculates the base name. The .code ftw -function returns +function returns either .code t -upon successful completion and -.code nil -on failure. If -.code ftw -is terminated by a return value from +upon successful completion, or an integer value returned by .metn callbackfun , -then that value is returned. Such a value is always a nonzero integer. +as described below. +On failure it throws an exception derived from +.codn file-error , +whose specific type is based on analyzing the POSIX +.code errno +value. The .meta callbackfun -may terminate the traversal by a nonlocal exit, such as by throwing +may return a value of any type. If it returns a value that is not of integer +type, then zero is returned to the +.code nftw +function and traversal continues. Similarly, traversal continues +if the function returns an integer zero. + +If +.meta callbackfun +returns an integer value, that value must be in the range of the C type +.codn int . +That +.code int +value is returned to +.codn nftw . +If the value is not zero, and is not -1, then +.code nftw +will terminate, and return that value, which +.code ftw +then returns. If the value is -1, then +.code nftw +is deemed to have failed, and +.code ftw +will thrown an exception of type +.codn file-error , +whose specific type is based on analyzing the POSIX +.code errno +value. If the value is zero, then the traversal continues. + +The +.meta callbackfun +may also terminate the traversal by a nonlocal exit, such as by throwing an exception or performing a block return. The |