Map Serialization

Detailed Description

Serialization.

Macros
#define	DW_MAPS_SERIALIZATION_FORMAT_XML_VERSION   5

Enumerations
enum	dwMapsSerializationFormat {   DW_MAPS_SERIALIZATION_FORMAT_BINARY = 0,   DW_MAPS_SERIALIZATION_FORMAT_XML = 1 }
	Serialization formats. More...

Functions
DW_API_PUBLIC dwStatus	dwMaps_serialize (const char *filename, dwMapsSerializationFormat format, dwConstMapHandle_t mapHandle)
	Stores current map content into a file. More...

Macro Definition Documentation

DW_MAPS_SERIALIZATION_FORMAT_XML_VERSION

#define DW_MAPS_SERIALIZATION_FORMAT_XML_VERSION   5

XML serialization file format version number

Definition at line 868 of file Maps.h.

Enumeration Type Documentation

dwMapsSerializationFormat

enum dwMapsSerializationFormat

Serialization formats.

Enumerator
DW_MAPS_SERIALIZATION_FORMAT_BINARY
DW_MAPS_SERIALIZATION_FORMAT_XML

Definition at line 862 of file Maps.h.

Function Documentation

dwMaps_serialize()

DW_API_PUBLIC dwStatus dwMaps_serialize	(	const char *	filename,
		dwMapsSerializationFormat	format,
		dwConstMapHandle_t	mapHandle
	)

Stores current map content into a file.

Parameters

[in]	filename	File to store the map data. Gets overwritten if it exists.
[in]	format	Serialization format.
[in]	mapHandle	Map to serialize.

Returns

DW_SUCCESS Successfully serialized map data into file.
DW_BAD_CAST Could not successfully cast handle to map object.
DW_INTERNAL_ERROR Error during point value serialization for xml.
DW_FILE_INVALID Could not open file for serialization.