Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Macros | Enumerations | Functions
wiced_resource.h File Reference

WICED Resource API's The Resource Management functions reads resource from a resource location and returns the number of bytes from an offset in an caller filled buffer. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  memory_resource_handle_t
 Memory handle. More...
 
struct  filesystem_resource_handle_t
 Filesystem handle. More...
 
struct  resource_hnd_t
 Resource handle structure. More...
 

Macros

#define RESOURCE_RESULT_LIST(prefix)
 Failed to read resource file. More...
 

Enumerations

Functions

resource_result_t resource_read (const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size, void *buffer)
 Read resource using the handle specified. More...
 
resource_result_t resource_get_readonly_buffer (const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size_out, const void **buffer)
 Retrieve a read only resource buffer using the handle specified. More...
 
resource_result_t resource_free_readonly_buffer (const resource_hnd_t *handle, const void *buffer)
 Free a read only resource buffer using the handle specified. More...
 

Detailed Description

WICED Resource API's The Resource Management functions reads resource from a resource location and returns the number of bytes from an offset in an caller filled buffer.

Functions to get the resource size and resource data

The Resource could be one of the three locations

Definition in file wiced_resource.h.

Macro Definition Documentation

#define RESOURCE_RESULT_LIST (   prefix)
Value:
RESULT_ENUM(prefix, SUCCESS, 0), /**< Success */ \
RESULT_ENUM(prefix, UNSUPPORTED, 7), /**< Unsupported function */ \
RESULT_ENUM(prefix, OFFSET_TOO_BIG, 4001), /**< Offset past end of resource */ \
RESULT_ENUM(prefix, FILE_OPEN_FAIL, 4002), /**< Failed to open resource file */ \
RESULT_ENUM(prefix, FILE_SEEK_FAIL, 4003), /**< Failed to seek to requested offset in resource file */ \
RESULT_ENUM(prefix, FILE_READ_FAIL, 4004),

Failed to read resource file.

Definition at line 83 of file wiced_resource.h.

Enumeration Type Documentation

Enumerator
RESOURCE_IN_MEMORY 

resource location in memory

RESOURCE_IN_FILESYSTEM 

resource location in filesystem

RESOURCE_IN_EXTERNAL_STORAGE 

resource location in external storage

Definition at line 146 of file wiced_resource.h.

Result type for WICED Resource function.

Enumerator
RESOURCE_SUCCESS 

Success.

RESOURCE_UNSUPPORTED 

Unsupported function.

RESOURCE_OFFSET_TOO_BIG 

Offset past end of resource.

RESOURCE_FILE_OPEN_FAIL 

Failed to open resource file.

RESOURCE_FILE_SEEK_FAIL 

Failed to seek to requested offset in resource file.

RESOURCE_FILE_READ_FAIL 

Failed to read resource file.

Definition at line 112 of file wiced_resource.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.