# std/private/ossymlinks

Theme:

- Manual
- Standard library
- Index
- Compiler docs
- Fusion docs
- devel, stable

Search:
Source Edit

# Imports

oserrors, oscommon, syncio, assertions, widestrs, posix

# Procs

    proc createSymlink(src, dest: string) {....raises: [OSError], tags: [], forbids: [].}

  Create a symbolic link at `dest` which points to the item specified by `src`. On most operating systems, will fail if a link already exists.
  Warning: Some OS's (such as Microsoft Windows) restrict the creation of symlinks to root users (administrators) or users with developer mode enabled.

  See also:

  - os: createHardlink proc
  - expandSymlink proc
  Source Edit

    proc expandSymlink(symlinkPath: string): string {....raises: [OSError], tags: [],
        forbids: [].}

  Returns a string representing the path to which the symbolic link points.

  On Windows this is a noop, `symlinkPath` is simply returned.

  See also:

  - createSymlink proc
  Source Edit

# Exports

symlinkExists