plugins/include/files.inc
changeset 1797 9242d6aa9f5b
parent 1796 db3a25745a2b
child 1854 91f2e0437e12
     1.1 --- a/plugins/include/files.inc	Sun Dec 16 23:11:00 2007 +0000
     1.2 +++ b/plugins/include/files.inc	Sun Dec 16 23:45:03 2007 +0000
     1.3 @@ -199,6 +199,7 @@
     1.4   * @param size			Size of each item in the array in bytes.  
     1.5   *						Valid sizes are 1, 2, or 4.
     1.6   * @return				True on success, false on error.
     1.7 + * @error				Invalid Handle.
     1.8   */
     1.9  native bool:WriteFile(Handle:hndl, const items[], num_items, size);
    1.10  
    1.11 @@ -209,6 +210,7 @@
    1.12   * @param buffer		String to write.
    1.13   * @param term			True to append NUL terminator, false otherwise.
    1.14   * @return				True on success, false on error.
    1.15 + * @error				Invalid Handle.
    1.16   */
    1.17  native bool:WriteFileString(Handle:hndl, const String:buffer[], bool:term);
    1.18  
    1.19 @@ -219,6 +221,7 @@
    1.20   * @param format		Formatting rules.
    1.21   * @param ...			Variable number of format parameters.
    1.22   * @return				True on success, false otherwise.
    1.23 + * @error				Invalid Handle.
    1.24   */
    1.25  native bool:WriteFileLine(Handle:hndl, const String:format[], any:...);
    1.26  
    1.27 @@ -230,6 +233,7 @@
    1.28   * @param size			Size of the data to read in bytes.  Valid 
    1.29   *						sizes are 1, 2, or 4 bytes.
    1.30   * @return				Number of elements read (max 1), or -1 on error.
    1.31 + * @error				Invalid Handle.
    1.32   */
    1.33  stock ReadFileCell(Handle:hndl, &data, size)
    1.34  {
    1.35 @@ -254,6 +258,7 @@
    1.36   *						rather than casted.  That is, only the lower 
    1.37   *						bits will be read.
    1.38   * @return				True on success, false on error.
    1.39 + * @error				Invalid Handle.
    1.40   */
    1.41  stock bool:WriteFileCell(Handle:hndl, data, size)
    1.42  {
    1.43 @@ -269,6 +274,7 @@
    1.44   *
    1.45   * @param file			Handle to the file.
    1.46   * @return				True if end of file has been reached, false otherwise.
    1.47 + * @error				Invalid Handle.
    1.48   */
    1.49  native bool:IsEndOfFile(Handle:file);
    1.50  
    1.51 @@ -279,6 +285,7 @@
    1.52   * @param position		Position relative to what is specified in whence.
    1.53   * @param where			SEEK_ constant value of where to see from.
    1.54   * @return				True on success, false otherwise.
    1.55 + * @error				Invalid Handle.
    1.56   */
    1.57  native bool:FileSeek(Handle:file, position, where);
    1.58  
    1.59 @@ -287,6 +294,7 @@
    1.60   *
    1.61   * @param file			Handle to the file.
    1.62   * @return				Value for the file position indicator.
    1.63 + * @error				Invalid Handle.
    1.64   */
    1.65  native FilePosition(Handle:file);
    1.66