|
|
File system hooksALLEGRO_FS_ENTRYOpaque filesystem entry object. Represents a file or a directory (check with al_is_directory or al_is_file). There are no user accessible member variables. EnumerationsALLEGRO_FILE_MODEFilesystem modes/types
Search Path Routinesal_add_search_pathAdds a path to the list of directories to search for files when searching/opening files with a relative pathname. al_get_search_pathFills in 'dest' up to 'len' bytes with the 'idx'th search path item. Parameters:
Returns true on success, and false on failure. errno is set to indicate the error. Possible Errors: * EINVAL - invalid item selected * ERANGE - buffer not large enough See also: al_get_errno al_search_path_countReturns the number of items in the search path list. File Manipulational_create_entryCreates an ALLEGRO_FS_ENTRY object pointing to path. 'path' can be a file or a directory and must not be NULL. al_destroy_entryDestroys a fs entry handle. Closes file if it was open. Does nothing if passed NULL. al_close_entryCloses fs entry. Does nothing if passed NULL. al_closedirCloses a previously opened directory entry object. al_close_entry is also a valid way to close any entry object. Does not free the entry object if it was opened with al_opendir. XXX This is probably a bug. Returns true on succes, false on failure and fills in errno to indicate the error. al_mkdirCreates a new directory on disk given the path 'path'. Returns false on error and fills in errno to indicate the error. See also: al_get_errno al_open_entryOpens handle with mode 'mode'. mode is a stdio type mode, ie: "r", "w", etc Returns true on success, false on failure and fills in errno to indicate the error. See also: al_get_errno al_opendirCreates and opens a filesystem entry object for a directory. Returns NULL on error. al_readdirReads the next dir item and returns a filesystem entry for it. Returns NULL on error. al_remove_entry"Unlink" or delete this file on disk. Returns true on success, and false on failure, error is indicated in errno. al_remove_strUnlink 'path' entry from disk. Returns true on success, and false on failure. errno is filled in to indicate the error. See Also: al_remove_entry al_fstatUpdates stat info for entry 'fp'. Returns true on success, false on failure. Fills in errno to indicate the error. See also al_get_errno al_get_entry_ctime al_is_file File Propertiesal_is_presentCheck if the given entry exists on disk. Returns true if it does exist or false if it doesn't exist, or an error occured. Error is indicated in errno. al_is_present_strCheck if entry 'path' exists on disk. See Also: al_is_present al_is_fileReturn true iff this entry is a regular file. al_is_directoryReturn true iff this entry is a directory. al_get_entry_modeReturns the entry's mode flags. See also: al_get_errno See the ALLEGRO_FILE_MODE enum for valid flags. al_get_entry_mode_strReturns stat 'mode' for fs entry 'path'. See Also: ALLEGRO_FILE_MODE al_get_entry_atimeReturns the time in seonds since the epoch since the entry was last accessed. Warning: some filesystem either don't support this flag, or people turn it off to increase performance. It may not be valid in all circumstances. al_get_entry_ctimeReturns the time in seconds since the epoch this entry was created on the filsystem. al_get_entry_mtimeReturns the time in seconds since the epoch since the entry was last modified. al_get_entry_nameReturns the entry's filename path. Note that the path will not be an absolute path if the entry wasn't created from an absolute path. Returns NULL on error. errno is set to indicate the error. al_get_entry_sizeReturns the size, in bytes, of the given entry. Otheral_getcwdReturns the path to the current working directory. Returns NULL on failure. errno is filled in to indicate the error. Possible Errors: * ERANGE - buffer is not large enough See also: al_get_errno al_chdirChanges the current working directory to 'path'. Returns -1 on error. al_path_sepFills in 'sep' up to 'len' characters with the path separator string. XXX return code? al_drive_sepFills in 'sep' up to 'len' characters with the drive separator string. XXX return code? |
Last updated: 2009-05-04 10:18:40 UTC