diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/fs_event.rst | 4 | ||||
| -rw-r--r-- | docs/src/fs_poll.rst | 4 | ||||
| -rw-r--r-- | docs/src/pipe.rst | 4 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/src/fs_event.rst b/docs/src/fs_event.rst index d92e88c8..681ae52f 100644 --- a/docs/src/fs_event.rst +++ b/docs/src/fs_event.rst @@ -94,11 +94,11 @@ API Stop the handle, the callback will no longer be called. -.. c:function:: int uv_fs_event_getpath(uv_fs_event_t* handle, char* buf, size_t* len) +.. c:function:: int uv_fs_event_getpath(uv_fs_event_t* handle, char* buffer, size_t* size) Get the path being monitored by the handle. The buffer must be preallocated by the user. Returns 0 on success or an error code < 0 in case of failure. - On success, `buf` will contain the path and `len` its length. If the buffer + On success, `buffer` will contain the path and `size` its length. If the buffer is not big enough UV_ENOBUFS will be returned and len will be set to the required size. diff --git a/docs/src/fs_poll.rst b/docs/src/fs_poll.rst index 58db1d2f..4efb2440 100644 --- a/docs/src/fs_poll.rst +++ b/docs/src/fs_poll.rst @@ -58,11 +58,11 @@ API Stop the handle, the callback will no longer be called. -.. c:function:: int uv_fs_poll_getpath(uv_fs_poll_t* handle, char* buf, size_t* len) +.. c:function:: int uv_fs_poll_getpath(uv_fs_poll_t* handle, char* buffer, size_t* size) Get the path being monitored by the handle. The buffer must be preallocated by the user. Returns 0 on success or an error code < 0 in case of failure. - On success, `buf` will contain the path and `len` its length. If the buffer + On success, `buffer` will contain the path and `size` its length. If the buffer is not big enough UV_ENOBUFS will be returned and len will be set to the required size. diff --git a/docs/src/pipe.rst b/docs/src/pipe.rst index 11e61302..01aea4ac 100644 --- a/docs/src/pipe.rst +++ b/docs/src/pipe.rst @@ -56,11 +56,11 @@ API Paths on Unix get truncated to ``sizeof(sockaddr_un.sun_path)`` bytes, typically between 92 and 108 bytes. -.. c:function:: int uv_pipe_getsockname(const uv_pipe_t* handle, char* buf, size_t* len) +.. c:function:: int uv_pipe_getsockname(const uv_pipe_t* handle, char* buffer, size_t* size) Get the name of the Unix domain socket or the named pipe. - A preallocated buffer must be provided. The len parameter holds the length + A preallocated buffer must be provided. The size parameter holds the length of the buffer and it's set to the number of bytes written to the buffer on output. If the buffer is not big enough ``UV_ENOBUFS`` will be returned and len will contain the required size. |