Method

GioFilemake_symbolic_link

Declaration

gboolean
g_file_make_symbolic_link (
  GFile* file,
  const char* symlink_value,
  GCancellable* cancellable,
  GError** error
)

Description

Creates a symbolic link named file which contains the string symlink_value.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned.

Parameters

symlink_value const char*
 

A string with the path for the target of the new symlink.

 The data is owned by the caller of the function.
 The value is a file system path, using the OS encoding.
cancellable GCancellable
 

Optional GCancellable object, NULL to ignore.

 The argument can be NULL.
 The data is owned by the caller of the function.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: gboolean
 

TRUE on the creation of a new symlink, FALSE otherwise.