api

unistd.ch

Declarations in unistd.ch

7 declarationscstd

Declarations

Public only
OpenFlags#
Publicenum
enum OpenFlags { ReadOnly, WriteOnly, ReadWrite, Create, Truncate }
PermissionMode#
Publicenum
enum PermissionMode { S_IXOTH, S_IWOTH, S_IROTH, S_IRWXO, S_IXGRP, S_IWGRP, S_IRGRP, S_IRWXG, S_IXUSR, S_IWUSR, S_IRUSR, S_IRWXU }
open#
Publicfunction
func open(pathname : *char, flags : int, mode : int) : int
@brief Open a file.

Parameters

  • pathname Path to the file. @param flags File access flags (O_RDONLY, O_WRONLY, O_RDWR). @param mode Permissions for new file (if O_CREAT). @return File descriptor ≥0 on success, or –1 on error.
  • flags File access flags (O_RDONLY, O_WRONLY, O_RDWR). @param mode Permissions for new file (if O_CREAT). @return File descriptor ≥0 on success, or –1 on error.
  • mode Permissions for new file (if O_CREAT). @return File descriptor ≥0 on success, or –1 on error.

Returns

File descriptor ≥0 on success, or –1 on error.

close#
Publicfunction
func close(fd : int) : int
@brief Close a file descriptor.

Parameters

  • fd File descriptor to close. @return 0 on success, –1 on error.

Returns

0 on success, –1 on error.

read#
Publicfunction
func read(fd : int, buf : *void, count : ulong) : ssize_t
@brief Read bytes from a file descriptor.

Parameters

  • fd File descriptor. @param buf Buffer to read into. @param count Maximum number of bytes to read. @return Number of bytes read (≥0), or –1 on error.
  • buf Buffer to read into. @param count Maximum number of bytes to read. @return Number of bytes read (≥0), or –1 on error.
  • count Maximum number of bytes to read. @return Number of bytes read (≥0), or –1 on error.

Returns

Number of bytes read (≥0), or –1 on error.

write#
Publicfunction
func write(fd : int, buf : *void, count : ulong) : ssize_t
@brief Write bytes to a file descriptor.

Parameters

  • fd File descriptor. @param buf Buffer containing data to write. @param count Number of bytes to write. @return Number of bytes written (≥0), or –1 on error.
  • buf Buffer containing data to write. @param count Number of bytes to write. @return Number of bytes written (≥0), or –1 on error.
  • count Number of bytes to write. @return Number of bytes written (≥0), or –1 on error.

Returns

Number of bytes written (≥0), or –1 on error.

mkdir#
Publicfunction
func mkdir(pathname : *char, mode : uint) : int
@brief Create a new directory.

Parameters

  • pathname Directory path to create. @param mode Permissions for the new directory. @return 0 on success, –1 on error.
  • mode Permissions for the new directory. @return 0 on success, –1 on error.

Returns

0 on success, –1 on error.