public/ISourceMod.h
changeset 1729 0f60cc4ce8bb
parent 1690 7cc4f79a0416
child 1894 e6efc8ffa47a
     1.1 --- a/public/ISourceMod.h	Tue Nov 27 01:59:38 2007 +0000
     1.2 +++ b/public/ISourceMod.h	Tue Nov 27 02:19:39 2007 +0000
     1.3 @@ -95,6 +95,15 @@
     1.4  		/**
     1.5  		 * @brief Builds a platform path for a specific target base path.
     1.6  		 *
     1.7 +		 * If the path starts with the string "file://" and the PathType is 
     1.8 +		 * not relative, then the "file://" portion is stripped off, and the 
     1.9 +		 * rest of the path is used without any modification (except for 
    1.10 +		 * correcting slashes).  This can be used to override the path 
    1.11 +		 * builder to supply alternate absolute paths.  Examples:
    1.12 +		 *
    1.13 +		 * file://C:/Temp/file.txt
    1.14 +		 * file:///tmp/file.txt
    1.15 +		 *
    1.16  		 * @param type		Type of path to use as a base.
    1.17  		 * @param buffer	Buffer to write to.
    1.18  		 * @param maxlength	Size of buffer.