Logo Search packages:      
Sourcecode: scummvm version File versions  Download package

This file contains an enum with commonly used error codes. Error codes which may be reported by plugins under various circumstances.

Todo:
Clarify the names; add more codes, resp. verify all existing ones are acutally useful. Also, try to avoid overlap.
Todo:
Maybe introduce a naming convention? E.g. k-NOUN/ACTION-CONDITION-Error, so kPathInvalidError would be correct, but these would not be: kInvalidPath, kPathInvalid, kPathIsInvalid, kInvalidPathError
Enumerator:
kNoError  No error occured.
kInvalidPathError  Engine initialization: Invalid game path was passed.
kNoGameDataFoundError  Engine initialization: No game data was found in the specified location.
kUnsupportedGameidError  Engine initialization: Gameid not supported by this (Meta)Engine.
kReadPermissionDenied  Unable to read data due to missing read permission.
kWritePermissionDenied  Unable to write data due to missing write permission.
kPathDoesNotExist  The specified path does not exist.
kPathNotDirectory  The specified path does not point to a directory.
kPathNotFile  The specified path does not point to a file.
kReadingFailed  Failed creating a (savestate) file.
kWritingFailed  Failure to write data -- disk full?
kUnknownError  Catch-all error, used if no other error code matches.

Definition at line 46 of file error.h.

           {
      kNoError = 0,                       //!< No error occured
      kInvalidPathError,                  //!< Engine initialization: Invalid game path was passed
      kNoGameDataFoundError,        //!< Engine initialization: No game data was found in the specified location
      kUnsupportedGameidError,      //!< Engine initialization: Gameid not supported by this (Meta)Engine


      kReadPermissionDenied,        //!< Unable to read data due to missing read permission
      kWritePermissionDenied,       //!< Unable to write data due to missing write permission

      // The following three overlap a bit with kInvalidPathError and each other. Which to keep?
      kPathDoesNotExist,                  //!< The specified path does not exist
      kPathNotDirectory,                  //!< The specified path does not point to a directory
      kPathNotFile,                       //!< The specified path does not point to a file

      kCreatingFileFailed,
      kReadingFailed,                     //!< Failed creating a (savestate) file
      kWritingFailed,                     //!< Failure to write data -- disk full?

      kUnknownError                       //!< Catch-all error, used if no other error code matches
};


Generated by  Doxygen 1.6.0   Back to index