pico-binary-info
Portable Pi Pico binary_info parser
Loading...
Searching...
No Matches
Error Handling

This library uses negative numbered constants for error codes. More...

Enumerations

enum  pico_binary_info_error {
  PICO_BI_ENOTFOUND = 1 ,
  PICO_BI_ENOHEADER ,
  PICO_BI_EWRONGTYPE ,
  PICO_BI_ERANGE ,
  PICO_BI_EBADADDR
}
 Library error codes, returned negated (e.g. More...

Detailed Description

This library uses negative numbered constants for error codes.

As a rule of thumb, whenever an function returns an integer, a negative number will imply an error.

Enumeration Type Documentation

◆ pico_binary_info_error

Library error codes, returned negated (e.g.

-PICO_BI_ENOTFOUND).

Enumerator
PICO_BI_ENOTFOUND 

No record found matching that id.

PICO_BI_ENOHEADER 

No binary_info header found in the image.

PICO_BI_EWRONGTYPE 

Record found but not the requested type.

PICO_BI_ERANGE 

Output buffer too small.

PICO_BI_EBADADDR 

A record's address could not be resolved to data within the image.