fixes in Static.File (documentation)

This commit is contained in:
mrexodia 2015-12-29 00:03:28 +01:00
parent 82c542bd62
commit 0b527f1985
2 changed files with 6 additions and 6 deletions

View File

@ -58,7 +58,7 @@ namespace GleeBug
return result; return result;
} }
bool File::Write(uint32 offset, const void* data, uint32 size, uint32* bytesWritten) const bool File::Write(uint32 offset, const void* data, uint32 size, uint32* bytesWritten)
{ {
if (!IsOpen() || SetFilePointer(_hFile, offset, nullptr, FILE_BEGIN) == INVALID_SET_FILE_POINTER) if (!IsOpen() || SetFilePointer(_hFile, offset, nullptr, FILE_BEGIN) == INVALID_SET_FILE_POINTER)
{ {

View File

@ -65,8 +65,8 @@ namespace GleeBug
\param offset The offset to start reading from. \param offset The offset to start reading from.
\param [out] data Destination buffer. \param [out] data Destination buffer.
\param size The size to read. \param size The size to read.
\param [out] bytesRead (Optional) If set, returns the number of bytes read. \param [out] bytesRead (Optional) If set, returns the number of bytes read (even on failure).
\return true if the read was successful, false otherwise. \return true if the read was fully successful, false otherwise.
*/ */
virtual bool Read(uint32 offset, void* data, uint32 size, uint32* bytesRead = nullptr) const; virtual bool Read(uint32 offset, void* data, uint32 size, uint32* bytesRead = nullptr) const;
@ -75,10 +75,10 @@ namespace GleeBug
\param offset The offset to start writing to. Everything after this offset will be truncated! \param offset The offset to start writing to. Everything after this offset will be truncated!
\param data The data to write. \param data The data to write.
\param size The size to write. \param size The size to write.
\param [out] bytesWritten (Optional) If set, returns the number of bytes written. \param [out] bytesWritten (Optional) If set, returns the number of bytes written (even on failure)
\return true if the write was successful, false otherwise. \return true if the write was fully successful, false otherwise.
*/ */
virtual bool Write(uint32 offset, const void* data, uint32 size, uint32* bytesWritten = nullptr) const; virtual bool Write(uint32 offset, const void* data, uint32 size, uint32* bytesWritten = nullptr);
private: private:
bool internalOpen(DWORD creation); bool internalOpen(DWORD creation);