next up previous contents index
Next: 7.4.5 open: Create an Up: 7.4 oskit_file: File Interface Previous: 7.4.3 access: Check accessibility

7.4.4 readlink: Read the contents of this symbolic link

 

SYNOPSIS

#include <oskit/fs/dir.h>

oskit_error_t oskit_file_readlink(oskit_file_t *f, char *buf, oskit_u32_t len, [out] oskit_u32_t *out_actual);

DIRECTION

client OS tex2html_wrap_inline32841 filesystem library

DESCRIPTION

If this file is a symbolic link, then this method reads the contents of the symbolic link into buf. No more than len bytes will be read. out_actual will be set to the actual number of bytes read.

PARAMETERS

f
The symbolic link file.
buf
The buffer into which the contents are to be copied.
len
The maximum number of bytes to read.
out_actual
The actual bytes read from the symlink.

RETURNS

Returns 0 on success, or an error code specified in <oskit/error.h>, on error.

If the file is not a symbolic link, then OSKIT_E_NOTIMPL is returned.



University of Utah Flux Research Group