Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-FileFlink()
Freadlink()
Fsymlink()                                                           GEMDOS

Syntax

LONG Fsymlink( oldname, newname )
char *oldname, *newname;

Function      Fsymlink() creates a symbolic link to a file.

Opcode        302 (0x12E)

Availability  Available when a 'MiNT' cookie with a version of at least
              0.90 exists.

Parameters    oldname points to the file specification of the file to
              create a link to. newname points to the file specification
              of the link to create.

Binding       pea      newname
              pea      oldname
              move.w   #$12E,-(sp)
              trap     #1
              lea      10(sp),sp

Return Value  Fsymlink() returns 0 if successful or a negative GEMDOS
              error code otherwise.

Comments      Fsymlink(), unlike Flink(), creates symbolic links, which,
              unlike hard links, can be setup between physical devices and
              file systems. An Fdelete() call to a symbolic link will
              delete the link, not the file. A call to Fdelete() on the
              original file will cause future references to the created
              symbolic link to fail.

See Also      Flink(), Freadlink()