diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2023-10-22 11:55:07 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-22 11:55:07 +0200 |
| commit | c5f027d6be3fbe6bf8ea9b3e9ff2a773fe94048c (patch) | |
| tree | f407235c76aeaa8f78d65929d9abd55161dcceb7 /docs/src | |
| parent | 9956da15670d8793b4f1d5b4bfe0c64169421f27 (diff) | |
| download | libuv-c5f027d6be3fbe6bf8ea9b3e9ff2a773fe94048c.tar.gz libuv-c5f027d6be3fbe6bf8ea9b3e9ff2a773fe94048c.zip | |
doc: filename arg to uv_fs_event_cb can be NULL (#4177)
Refs: https://github.com/libuv/libuv/issues/4160
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/fs_event.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/src/fs_event.rst b/docs/src/fs_event.rst index e28ec625..54a776ae 100644 --- a/docs/src/fs_event.rst +++ b/docs/src/fs_event.rst @@ -39,8 +39,12 @@ Data types .. c:type:: void (*uv_fs_event_cb)(uv_fs_event_t* handle, const char* filename, int events, int status) Callback passed to :c:func:`uv_fs_event_start` which will be called repeatedly - after the handle is started. If the handle was started with a directory the - `filename` parameter will be a relative path to a file contained in the directory. + after the handle is started. + + If the handle was started with a directory the `filename` parameter will + be a relative path to a file contained in the directory, or `NULL` if the + file name cannot be determined. + The `events` parameter is an ORed mask of :c:type:`uv_fs_event` elements. .. c:type:: uv_fs_event |