videolan/vlc
1
Fork 0
mirror of https://code.videolan.org/videolan/vlc synced 2024-10-03 01:31:53 +02:00
Code Releases Activity

include: improve vlc_fs.h documentation

Browse Source
This commit is contained in:
Rémi Denis-Courmont 2015-05-14 17:29:58 +03:00
parent de62d30bfc
commit 128a1f1724
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/vlc_fs.h
View File

@ -23,9 +23,20 @@
/**
* \file
* Those functions convert file paths from UTF-8 to the system-specific
* encoding (especially UTF-16 on Windows). Also, they always mark file
* descriptor with the close-on-exec flag.
* The functions in this file help with using low-level Unix-style file
* descriptors, BSD sockets and directories. In general, they retain the
* prototype and most semantics from their respective standard equivalents.
* However, there are a few differences:
* - On Windows, file path arguments are expected in UTF-8 format.
* They are converted to UTF-16 internally, thus enabling access to paths
* outside of the local Windows ANSI code page.
* - On POSIX systems, file descriptors are created with the close-on-exec
* flag set (atomically where possible), so that they do not leak to
* child process after fork-and-exec.
* - vlc_scandir(), inspired by GNU scandir(), passes file names rather than
* dirent structure pointers to its callbacks.
* - vlc_accept() takes an extra boolean for nonblocking mode (compare with
* the flags parameter in POSIX.next accept4()).
*/
#include <sys/types.h>