Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation from source code
Components
gb
*[]
.Array.Bounds
.Stat.Perm
.Stream.Lines
.Stream.Term
.Symbol
_BoxedString
Application
Args
Array
Boolean[]
Byte[]
Class
Classes
Collection
Component
Components
Date[]
Enum
Env
Error
File
BaseName
DefaultDirAuth
Dir
Err
Ext
In
IsHidden
IsRelative
Load
Name
Out
Read
RealPath
Resize
Save
SetBaseName
SetDir
SetExt
SetName
Write
Float[]
gb
Integer[]
Jit
Long[]
Object
Object[]
Observer
Param
Pointer[]
Process
Short[]
Single[]
Stat
Stream
String
String[]
System
Task
Timer
User
Variant[]
gb.args
gb.cairo
gb.chart
gb.clipper
gb.clipper2
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.db2
gb.db2.form
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

File.RealPath (gb)

Static Function RealPath ( Path As String [ , Parent As Boolean ] ) As String

Since 3.13

Return the canonical absolute pathname of a path, with no symbolic links inside.

Since 3.20

If the optional Parent argument is TRUE, and if Path is a relative path received from another component (usually by a function argument), then the returned path will be modified so that it points at the same file.

For example, if Path is ./image.png, then File.Path("./image.png", True) will return ../image.png, so that the new path points at the same file as the old path from a calling component.

This function is useful when a public API of a component receives a file path from a call located in another component, usually the main project.

Example

' The Response.SendFile() method from the gb.web component
Public Sub SendFile(Path As String, Optional ContentType As String)
  
  Dim sBuffer As String
  Dim hFile As File

  $bDone = True

  Path = File.RealPath(Path, True)

  If Not Exist(Path) Then
    Print "Status: 404 Not Found"
    Print
    Return
  Endif

  ...
  
End

You must sure that the path comes from another component before using this feature, and you must call it once.

For example, you can't call Response.SendFile() from the same component (i.e. from gb.web source code) with a local path, because then it will search for that file in the parent component, not in the gb.web component.