Fetching Common Field Values

Convenience functions for fetching common field values. More...

Functions
int	pico_binary_info_get_program_name (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the program name string.
int	pico_binary_info_get_program_version (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the program version string.
int	pico_binary_info_get_program_build_date (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the program build date string.
int	pico_binary_info_get_program_url (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the program url string.
int	pico_binary_info_get_program_description (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the program description string.
int	pico_binary_info_get_program_feature (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch a program feature string.
int	pico_binary_info_get_program_build_attribute (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch a program build attribute string.
int	pico_binary_info_get_sdk_version (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the SDK version string.
int	pico_binary_info_get_pico_board (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the pico board string.
int	pico_binary_info_get_boot2_name (struct pico_binary_info *info, char *out, size_t out_len)
	Fetch the boot2 name string.
int	pico_binary_info_get_binary_end (struct pico_binary_info *info, uint32_t *out)
	Fetch the binary end address.

Detailed Description

Convenience functions for fetching common field values.

Function Documentation

pico_binary_info_get_binary_end()

int pico_binary_info_get_binary_end	(	struct pico_binary_info *	info,
		uint32_t *	out )

Fetch the binary end address.

Parameters

info	the initialized binary info struct
out	where to store the integer

Returns

0 for success, negative error code on failure

pico_binary_info_get_boot2_name()

int pico_binary_info_get_boot2_name	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the boot2 name string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_pico_board()

int pico_binary_info_get_pico_board	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the pico board string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_build_attribute()

int pico_binary_info_get_program_build_attribute	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch a program build attribute string.

A binary may carry several build attribute records; this returns the first one found.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_build_date()

int pico_binary_info_get_program_build_date	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the program build date string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_description()

int pico_binary_info_get_program_description	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the program description string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_feature()

int pico_binary_info_get_program_feature	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch a program feature string.

A binary may carry several feature records; this returns the first one found.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_name()

int pico_binary_info_get_program_name	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the program name string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_url()

int pico_binary_info_get_program_url	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the program url string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_program_version()

int pico_binary_info_get_program_version	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the program version string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure

pico_binary_info_get_sdk_version()

int pico_binary_info_get_sdk_version	(	struct pico_binary_info *	info,
		char *	out,
		size_t	out_len )

Fetch the SDK version string.

Parameters

info	the initialized binary info struct
out	where to store the string
out_len	the size of out string buffer

Returns

0 for success, negative error code on failure