1.1 --- a/plugins/include/files.inc Mon Feb 12 08:28:35 2007 +0000
1.2 +++ b/plugins/include/files.inc Mon Feb 12 09:00:55 2007 +0000
1.3 @@ -1,4 +1,5 @@
1.4 /**
1.5 + * vim: set ts=4 :
1.6 * ===============================================================
1.7 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
1.8 * ===============================================================
1.9 @@ -78,17 +79,17 @@
1.10 * @note Files are closed with CloseHandle().
1.11 * @note File Handles can be cloned.
1.12 *
1.13 - * @param file File to open.
1.14 - * @param mode Open mode.
1.15 - * @return A Handle to the file, INVALID_HANDLE on open error.
1.16 + * @param file File to open.
1.17 + * @param mode Open mode.
1.18 + * @return A Handle to the file, INVALID_HANDLE on open error.
1.19 */
1.20 native Handle:OpenFile(const String:file[], const String:mode[]);
1.21
1.22 /**
1.23 * @brief Deletes a file.
1.24 *
1.25 - * @param path Path of the file to delete.
1.26 - * @return True on success, false otherwise.
1.27 + * @param path Path of the file to delete.
1.28 + * @return True on success, false otherwise.
1.29 */
1.30 native bool:DeleteFile(const String:path[]);
1.31
1.32 @@ -105,34 +106,34 @@
1.33 /**
1.34 * @brief Tests if the end of file has been reached.
1.35 *
1.36 - * @param file Handle to the file.
1.37 - * @return True if end of file has been reached, false otherwise.
1.38 + * @param file Handle to the file.
1.39 + * @return True if end of file has been reached, false otherwise.
1.40 */
1.41 native bool:IsEndOfFile(Handle:file);
1.42
1.43 /**
1.44 * @brief Sets the file position indicator.
1.45 *
1.46 - * @param file Handle to the file.
1.47 - * @param position Position relative to what is specified in whence.
1.48 - * @param whence Look at the SEEK_* definitions.
1.49 - * @return True on success, false otherwise.
1.50 + * @param file Handle to the file.
1.51 + * @param position Position relative to what is specified in whence.
1.52 + * @param whence Look at the SEEK_* definitions.
1.53 + * @return True on success, false otherwise.
1.54 */
1.55 native bool:FileSeek(Handle:file, position, whence);
1.56
1.57 /**
1.58 * @brief Get current position in the file.
1.59 *
1.60 - * @param file Handle to the file.
1.61 - * @return Value for the file position indicator.
1.62 + * @param file Handle to the file.
1.63 + * @return Value for the file position indicator.
1.64 */
1.65 native FilePosition(Handle:file);
1.66
1.67 /**
1.68 * @brief Checks if a file exists.
1.69 *
1.70 - * @param path Path to the file.
1.71 - * @return True if the file exists, false otherwise.
1.72 + * @param path Path to the file.
1.73 + * @return True if the file exists, false otherwise.
1.74 */
1.75 native bool:FileExists(const String:path[]);
1.76
1.77 @@ -148,16 +149,16 @@
1.78 /**
1.79 * @brief Checks if a directory exists.
1.80 *
1.81 - * @param path Path to the directory.
1.82 - * @return True if the directory exists, false otherwise.
1.83 + * @param path Path to the directory.
1.84 + * @return True if the directory exists, false otherwise.
1.85 */
1.86 native bool:DirExists(const String:path[]);
1.87
1.88 /**
1.89 * @brief Get the file size in bytes.
1.90 *
1.91 - * @param path Path to the file.
1.92 - * @return File size in bytes, -1 if file not found.
1.93 + * @param path Path to the file.
1.94 + * @return File size in bytes, -1 if file not found.
1.95 */
1.96 native FileSize(const String:path[]);
1.97
1.98 @@ -165,8 +166,8 @@
1.99 * @brief Removes a directory.
1.100 * @note On most Operating Systems you cannot remove a directory which has files inside it.
1.101 *
1.102 - * @param path Path to the directory.
1.103 - * @return True on success, false otherwise.
1.104 + * @param path Path to the directory.
1.105 + * @return True on success, false otherwise.
1.106 */
1.107 native bool:RemoveDir(const String:path[]);
1.108
1.109 @@ -174,9 +175,9 @@
1.110 * @brief Writes a line of text in a file.
1.111 * @note This native will append the newline character.
1.112 *
1.113 - * @param hndl Handle to the file.
1.114 - * @param format Formatting rules.
1.115 - * @param ... Variable number of format parameters.
1.116 - * @return True on success, false otherwise.
1.117 + * @param hndl Handle to the file.
1.118 + * @param format Formatting rules.
1.119 + * @param ... Variable number of format parameters.
1.120 + * @return True on success, false otherwise.
1.121 */
1.122 native bool:WriteFileLine(Handle:hndl, const String:format[], {Handle,Float,String,_}:...);
