Package Archive Info API. It provides functions for getting information of the package archive.
Required Header
#include <package_archive_info.h>
Overview
The Package Archive Info API provides functions to get information from the package archive. You can get basic information such as package id, description, label, author and so on. Also you can get raw data of icon of the package archive.
Functions |
int | package_archive_info_create (const char *path, package_archive_info_h *archive_info) |
| Creates the package archive information for the given package.
|
int | package_archive_info_destroy (package_archive_info_h archive_info) |
| Destroys the package archive information handle.
|
int | package_archive_info_get_package (package_archive_info_h archive_info, char **package) |
| Gets the package name.
|
int | package_archive_info_get_type (package_archive_info_h archive_info, char **type) |
| Gets the type of the package.
|
int | package_archive_info_get_version (package_archive_info_h archive_info, char **version) |
| Gets the version of the package.
|
int | package_archive_info_get_api_version (package_archive_info_h archive_info, char **api_version) |
| Gets the API version of the package.
|
int | package_archive_info_get_description (package_archive_info_h archive_info, char **description) |
| Gets the description of the package.
|
int | package_archive_info_get_label (package_archive_info_h archive_info, char **label) |
| Gets the label of the package.
|
int | package_archive_info_get_author (package_archive_info_h archive_info, char **author) |
| Gets the author of the package.
|
int | package_archive_info_get_icon (package_archive_info_h archive_info, unsigned char **icon, size_t *icon_size) |
| Gets the raw icon of the package.
|
int | package_archive_info_foreach_direct_dependency (package_archive_info_h archive_info, package_info_dependency_info_cb callback, void *user_data) |
| Retrieves direct dependencies of the given package.
|
Typedefs |
typedef struct
package_archive_info_s * | package_archive_info_h |
| The package archive information handle.
|
Typedef Documentation
The package archive information handle.
- Since :
- 4.0
Function Documentation
Creates the package archive information for the given package.
- Since :
- 4.0
- Parameters:
-
[in] | path | The path of the package |
[out] | archive_info | The package archive information for the given package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- package_archive_info_destroy()
Destroys the package archive information handle.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information handle |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- package_archive_info_create()
Retrieves direct dependencies of the given package.
package_info_dependency_info_cb() is called for each direct dependency of the given package. For example, if there are packages having the following relationship:
B --> E
A --> B --> C
D --> C
A --> B means that A depends on B.
If package_archive_info_foreach_direct_dependency(A) is called, the callback will be called once with the following argument values: from = A, to = B.
- Since :
- 5.5
- Parameters:
-
[in] | archive_info | The package archive information |
[in] | callback | The iteration callback function |
[in] | user_data | The user data to be passed to the callback function |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the API version of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | api_version | The API version of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the author of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | author | The author of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the description of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | description | The description of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the raw icon of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | icon | The raw icon of the package |
[out] | icon_size | The size of the icon |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the label of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | label | The label of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the package name.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | package | The package name |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the type of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | type | The type of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the version of the package.
- Since :
- 4.0
- Parameters:
-
[in] | archive_info | The package archive information |
[out] | version | The version of the package |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-