/////////////////////////////////////////////////////////////////////////////
// Name: file.h
-// Purpose: documentation for wxTempFile class
+// Purpose: interface of wxTempFile
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
};
+
/**
@class wxFile
@wxheader{file.h}
/**
Associates the file with the given file descriptor, which has already been
opened.
-
+
@param filename
The filename.
@param mode
/**
Destructor will close the file.
- @b NB: it is not virtual so you should not use wxFile polymorphically.
+ @note it is not virtual so you should not use wxFile polymorphically.
*/
~wxFile();
/**
Opens the file, returning @true if successful.
-
+
@param filename
The filename.
@param mode
/**
Seeks to the specified position.
-
+
@param ofs
Offset to seek to.
@param mode
One of wxFromStart, wxFromEnd, wxFromCurrent.
-
+
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/
Moves the file pointer to the specified number of bytes relative to the end of
the file. For example, @c SeekEnd(-5) would position the pointer 5
bytes before the end.
-
+
@param ofs
Number of bytes before the end of the file.
-
+
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/
*/
int fd() const;
};
+