X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Freference-v3%2Ffunc-api.md;h=ef3816d03dd9d1c1f70f761df9efb6065c7e582f;hb=5ef271effacb83552f9ea56572c751c2f5a556b6;hp=0ba141df84e0ab5ac411b0c562aaa161876b2a50;hpb=525e9eaa644ca92fad23adfbb7c3119ae8b57a30;p=src%2Fapp-framework-binder.git diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md index 0ba141df..ef3816d0 100644 --- a/docs/reference-v3/func-api.md +++ b/docs/reference-v3/func-api.md @@ -56,9 +56,9 @@ void afb_api_set_userdata( ```C /** * Check that it requires the API of 'name'. - * If 'initialized' is not zero it request the API to be + * If 'initialized' is not zero it requests the API to be * initialized, implying its initialization if needed. - * + * * Calling this function is only allowed within init. * * A single request allows to require multiple apis. @@ -199,7 +199,7 @@ void afb_api_verbose( * Get the root directory file descriptor. This file descriptor can * be used with functions 'openat', 'fstatat', ... * - * CAUTION, manipulate this this descriptor with care, in particular, don't close + * CAUTION, manipulate this descriptor with care, in particular, don't close * it. * * This can be used to get the path of the root directory using: @@ -255,6 +255,24 @@ int afb_api_rootdir_open_locale( const char *locale); ``` +### afb_api_settings + +```C +/** + * Settings of the api. + * + * Get the settings of the API. The settings are recorded + * as a JSON object. The returned object should not be modified. + * It MUST NOT be released using json_object_put. + * + * @param api the api whose settings are required + * + * @returns The setting object. + */ +struct json_object *afb_api_settings( + struct afb_api_x3 *api); +``` + ## Calls and job functions ### afb_api_call @@ -579,9 +597,9 @@ struct sd_bus *afb_api_get_system_bus( * @param info the brief description of the new api (can be NULL) * @param noconcurrency zero or not zero whether the new api is reentrant or not * @param preinit the pre-initialization function if any (can be NULL) - * @param closure the closure for the pre-initialization \ref preinit + * @param closure the closure for the pre-initialization preinit * - * @return 0 in case of success or -1 on failure with errno set + * @return the created api in case of success or NULL on error * * @see afb_api_delete_api */