BLO_writefile.h File Reference

external writefile function prototypes. More...

Go to the source code of this file.

Classes
struct	BlendFileWriteParams

BLO Write File API
See also BLO_read_from_file for file reading.
enum	eBLO_WritePathRemap { BLO_WRITE_PATH_REMAP_NONE = 0 , BLO_WRITE_PATH_REMAP_RELATIVE = 1 , BLO_WRITE_PATH_REMAP_RELATIVE_ALL = 2 , BLO_WRITE_PATH_REMAP_ABSOLUTE = 3 }
typedef enum eBLO_WritePathRemap	eBLO_WritePathRemap
bool	BLO_write_file (struct Main *mainvar, const char *filepath, const int write_flags, const struct BlendFileWriteParams *params, struct ReportList *reports)
bool	BLO_write_file_mem (struct Main *mainvar, struct MemFile *compare, struct MemFile *current, int write_flags)

Detailed Description

external writefile function prototypes.

Definition in file BLO_writefile.h.

Typedef Documentation

eBLO_WritePathRemap

typedef enum eBLO_WritePathRemap eBLO_WritePathRemap

Adjust paths when saving (kept unless BlendFileWriteParams.use_save_as_copy is set).

Enumeration Type Documentation

eBLO_WritePathRemap

enum eBLO_WritePathRemap

Adjust paths when saving (kept unless BlendFileWriteParams.use_save_as_copy is set).

Enumerator
BLO_WRITE_PATH_REMAP_NONE	No path manipulation.
BLO_WRITE_PATH_REMAP_RELATIVE	Remap existing relative paths (default).
BLO_WRITE_PATH_REMAP_RELATIVE_ALL	Remap paths making all paths relative to the new location.
BLO_WRITE_PATH_REMAP_ABSOLUTE	Make all paths absolute.

Definition at line 41 of file BLO_writefile.h.

Function Documentation

BLO_write_file()

bool BLO_write_file	(	Main *	mainvar,
		const char *	filepath,
		const int	write_flags,
		const struct BlendFileWriteParams *	params,
		ReportList *	reports
	)

Returns

Success.

Definition at line 1128 of file writefile.c.

References BKE_bpath_absolute_convert(), BKE_bpath_list_backup(), BKE_bpath_list_free(), BKE_bpath_list_restore(), BKE_bpath_relative_convert(), BKE_bpath_relative_rebase(), BKE_BPATH_TRAVERSE_SKIP_LIBRARY, BKE_BPATH_TRAVERSE_SKIP_MULTIFILE, BKE_report(), BKE_reportf(), BLI_assert, BLI_path_cmp, BLI_path_normalize(), BLI_rename(), BLI_snprintf(), BLI_split_dir_part(), BLO_main_validate_libraries(), BLO_main_validate_shapekeys(), BLO_WRITE_PATH_REMAP_ABSOLUTE, BLO_WRITE_PATH_REMAP_NONE, BLO_WRITE_PATH_REMAP_RELATIVE, BLO_WRITE_PATH_REMAP_RELATIVE_ALL, WriteWrap::close, do_history(), err, FILE_MAX, G, G_DEBUG_IO, G_FILE_COMPRESS, Main::lock, Main::name, NULL, WriteWrap::open, params, RPT_ERROR, RPT_INFO, UNLIKELY, write_file_handle(), ww_handle_init(), WW_WRAP_NONE, and WW_WRAP_ZLIB.

Referenced by BKE_blendfile_userdef_write(), BKE_blendfile_write_partial(), BKE_memfile_undo_encode(), wm_autosave_write(), WM_exit_ex(), wm_file_write(), wm_homefile_write_exec(), and write_crash_blend().

BLO_write_file_mem()

bool BLO_write_file_mem	(	Main *	mainvar,
		MemFile *	compare,
		MemFile *	current,
		int	write_flags
	)

Returns

Success.

Definition at line 1276 of file writefile.c.

References err, NULL, and write_file_handle().

Referenced by BKE_memfile_undo_encode().