Functions to initialize, load and release map data.
◆ dwMaps_initialize()
Creates a map handle and initializes the map data by deserializing a driveworks maps file.
Buffer sizes are allocated to fit the file content.
- Note
- : allocates memory.
- Parameters
-
[out] | mapHandle | mapHandle to be initialized |
[in] | filename | path to driveworks maps file |
[in] | contextHandle | driveworks context |
- Returns
- DW_SUCCESS Map handle is successfully initialized.
DW_INVALID_ARGUMENT mapHandle, filename is nullptr.
DW_FAILURE Error during maps backend access, or invalid enum encountered.
DW_FILE_INVALID Error loading file: not a valid driveworks maps file.
◆ dwMaps_release()
Release map handle.
- Note
- : Releases memory.
- Parameters
-
[in,out] | mapHandle | map handle to be released. |
- Returns
- DW_SUCCESS Successfully released map object and handle.
DW_BAD_CAST Could not successfully cast handle to map object.