From: Ji-hoon Lee Date: Thu, 26 Sep 2024 07:35:18 +0000 (+0900) Subject: Specify that tizen feature is required to use MMI APIs X-Git-Tag: accepted/tizen/unified/20241001.004133~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=86108c1e8dfeef2ef573042dec35effd94ab05d6;p=platform%2Fcore%2Fuifw%2Fmmi-framework.git Specify that tizen feature is required to use MMI APIs Change-Id: I296f342d4a261f25c009e332b258f8b5f37cb43a --- diff --git a/capi/common/mmi-attribute.h b/capi/common/mmi-attribute.h index b4757b3..30e43ec 100644 --- a/capi/common/mmi-attribute.h +++ b/capi/common/mmi-attribute.h @@ -59,6 +59,7 @@ typedef struct mmi_attribute_s* mmi_attribute_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -85,6 +86,7 @@ int mmi_attribute_create(mmi_primitive_value_h value, const char *name, mmi_attr * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_attribute_set_name(mmi_attribute_h attribute, const char *name); @@ -100,6 +102,7 @@ int mmi_attribute_set_name(mmi_attribute_h attribute, const char *name); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -127,6 +130,7 @@ int mmi_attribute_get_name(mmi_attribute_h attribute, char **name); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -153,6 +157,7 @@ int mmi_attribute_get_value(mmi_attribute_h attribute, mmi_primitive_value_h *va * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -178,6 +183,7 @@ int mmi_attribute_clone(mmi_attribute_h attribute, mmi_attribute_h *cloned); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_attribute_destroy(mmi_attribute_h attribute); @@ -194,6 +200,7 @@ int mmi_attribute_destroy(mmi_attribute_h attribute); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -223,6 +230,7 @@ int mmi_attribute_to_bytes(mmi_attribute_h attribute, unsigned char **bytes, siz * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -253,6 +261,7 @@ int mmi_attribute_from_bytes(const unsigned char *bytes, size_t length, mmi_attr * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * diff --git a/capi/common/mmi-data.h b/capi/common/mmi-data.h index 7118071..38fceaf 100644 --- a/capi/common/mmi-data.h +++ b/capi/common/mmi-data.h @@ -78,6 +78,7 @@ typedef struct mmi_data_s *mmi_data_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -104,6 +105,7 @@ int mmi_data_create_bool(bool value, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -130,6 +132,7 @@ int mmi_data_create_int(int value, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -156,6 +159,7 @@ int mmi_data_create_float(float value, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -184,6 +188,7 @@ int mmi_data_create_text(const char *value, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -213,6 +218,7 @@ int mmi_data_create_audio(const void *ptr, size_t len, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -242,6 +248,7 @@ int mmi_data_create_video(const void *ptr, size_t len, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -271,6 +278,7 @@ int mmi_data_create_user_identification(const void *ptr, size_t len, mmi_data_h * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -300,6 +308,7 @@ int mmi_data_create_coordinate(int x, int y, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -325,6 +334,7 @@ int mmi_data_create_bounding_box(int x, int y, int w, int h, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -350,6 +360,7 @@ int mmi_data_create_array(mmi_data_h *array_handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -365,6 +376,7 @@ int mmi_data_add_array_element(mmi_data_h array_handle, mmi_data_h element); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -391,6 +403,7 @@ int mmi_data_create_struct(mmi_data_h *struct_handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -406,6 +419,7 @@ int mmi_data_set_struct_element(mmi_data_h struct_handle, const char *name, mmi_ * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_get_type(mmi_data_h data, mmi_data_type_e *type); @@ -420,6 +434,7 @@ int mmi_data_get_type(mmi_data_h data, mmi_data_type_e *type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_get_bool(mmi_data_h data, bool *value); @@ -434,6 +449,7 @@ int mmi_data_get_bool(mmi_data_h data, bool *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_get_int(mmi_data_h data, int *value); @@ -448,6 +464,7 @@ int mmi_data_get_int(mmi_data_h data, int *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_get_float(mmi_data_h data, float *value); @@ -464,6 +481,7 @@ int mmi_data_get_float(mmi_data_h data, float *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -490,6 +508,7 @@ int mmi_data_get_text(mmi_data_h data, const char **text); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -517,6 +536,7 @@ int mmi_data_get_audio(mmi_data_h data, const void **ptr, size_t *len); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -544,6 +564,7 @@ int mmi_data_get_video(mmi_data_h data, const void **ptr, size_t *len); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -569,6 +590,7 @@ int mmi_data_get_user_identification(mmi_data_h data, const void **ptr, size_t * * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_get_coordinate(mmi_data_h data, int *x, int *y); @@ -587,6 +609,7 @@ int mmi_data_get_coordinate(mmi_data_h data, int *x, int *y); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -603,6 +626,7 @@ int mmi_data_get_bounding_box(mmi_data_h data, int *x, int *y, int *w, int *h); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -621,6 +645,7 @@ int mmi_data_get_array_count(mmi_data_h array, size_t *count); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -649,6 +674,7 @@ int mmi_data_get_array_element(mmi_data_h array, size_t index, mmi_data_h *eleme * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -675,6 +701,7 @@ int mmi_data_get_struct_element(mmi_data_h struct_handle, const char *name, mmi_ * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -693,6 +720,7 @@ int mmi_data_get_struct_count(mmi_data_h struct_handle, size_t *count); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -721,6 +749,7 @@ int mmi_data_get_struct_element_name(mmi_data_h struct_handle, size_t index, con * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -748,6 +777,7 @@ int mmi_data_get_struct_element_value(mmi_data_h struct_handle, size_t index, mm * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -777,6 +807,7 @@ int mmi_data_to_bytes(mmi_data_h data, unsigned char **bytes, size_t *length); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -803,6 +834,7 @@ int mmi_data_from_bytes(unsigned char *bytes, size_t length, mmi_data_h *data); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_data_destroy(mmi_data_h data); diff --git a/capi/common/mmi-primitive-value.h b/capi/common/mmi-primitive-value.h index 6dee42c..836f1bd 100644 --- a/capi/common/mmi-primitive-value.h +++ b/capi/common/mmi-primitive-value.h @@ -71,6 +71,7 @@ typedef struct mmi_primitive_value_s* mmi_primitive_value_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -97,6 +98,7 @@ int mmi_primitive_value_create_int(int data, mmi_primitive_value_h *handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -123,6 +125,7 @@ int mmi_primitive_value_create_float(float data, mmi_primitive_value_h *handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -149,6 +152,7 @@ int mmi_primitive_value_create_string(const char *data, mmi_primitive_value_h *h * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -174,6 +178,7 @@ int mmi_primitive_value_create_bool(bool data, mmi_primitive_value_h *handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -199,6 +204,7 @@ int mmi_primitive_value_create_array(mmi_primitive_value_h *handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_add_array_element(mmi_primitive_value_h array, mmi_primitive_value_h element); @@ -213,6 +219,7 @@ int mmi_primitive_value_add_array_element(mmi_primitive_value_h array, mmi_primi * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_get_type(mmi_primitive_value_h handle, mmi_primitive_value_type_e *type); @@ -227,6 +234,7 @@ int mmi_primitive_value_get_type(mmi_primitive_value_h handle, mmi_primitive_val * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_get_int(mmi_primitive_value_h handle, int *value); @@ -241,6 +249,7 @@ int mmi_primitive_value_get_int(mmi_primitive_value_h handle, int *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_get_float(mmi_primitive_value_h handle, float *value); @@ -257,6 +266,7 @@ int mmi_primitive_value_get_float(mmi_primitive_value_h handle, float *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -280,6 +290,7 @@ int mmi_primitive_value_get_string(mmi_primitive_value_h handle, const char **st * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_get_bool(mmi_primitive_value_h handle, bool *value); @@ -294,6 +305,7 @@ int mmi_primitive_value_get_bool(mmi_primitive_value_h handle, bool *value); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_get_array_count(mmi_primitive_value_h array, size_t *count); @@ -311,6 +323,7 @@ int mmi_primitive_value_get_array_count(mmi_primitive_value_h array, size_t *cou * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -336,6 +349,7 @@ int mmi_primitive_value_get_array_element(mmi_primitive_value_h array, size_t in * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -361,6 +375,7 @@ int mmi_primitive_value_clone(mmi_primitive_value_h handle, mmi_primitive_value_ * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_primitive_value_destroy(mmi_primitive_value_h handle); @@ -377,6 +392,7 @@ int mmi_primitive_value_destroy(mmi_primitive_value_h handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -406,6 +422,7 @@ int mmi_primitive_value_to_bytes(mmi_primitive_value_h handle, unsigned char **b * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * diff --git a/capi/common/mmi-signal.h b/capi/common/mmi-signal.h index 2917bed..296ec80 100644 --- a/capi/common/mmi-signal.h +++ b/capi/common/mmi-signal.h @@ -67,6 +67,7 @@ typedef struct mmi_signal_s* mmi_signal_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -94,6 +95,7 @@ int mmi_signal_parameter_create(mmi_primitive_value_h value, const char *name, * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -121,6 +123,7 @@ int mmi_signal_parameter_get_name(mmi_signal_parameter_h parameter, char **name) * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -148,6 +151,7 @@ int mmi_signal_parameter_get_value(mmi_signal_parameter_h parameter, mmi_primiti * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -173,6 +177,7 @@ int mmi_signal_parameter_clone(mmi_signal_parameter_h parameter, mmi_signal_para * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_signal_parameter_destroy(mmi_signal_parameter_h parameter); @@ -188,6 +193,7 @@ int mmi_signal_parameter_destroy(mmi_signal_parameter_h parameter); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -213,6 +219,7 @@ int mmi_signal_create(const char *name, mmi_signal_h *handle); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_signal_add_parameter(mmi_signal_h handle, mmi_signal_parameter_h parameter); @@ -228,6 +235,7 @@ int mmi_signal_add_parameter(mmi_signal_h handle, mmi_signal_parameter_h paramet * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -254,6 +262,7 @@ int mmi_signal_get_name(mmi_signal_h handle, char **name); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_signal_get_parameter_count(mmi_signal_h handle, int *count); @@ -270,6 +279,7 @@ int mmi_signal_get_parameter_count(mmi_signal_h handle, int *count); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -294,6 +304,7 @@ int mmi_signal_get_parameter(mmi_signal_h handle, int index, mmi_signal_paramete * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_signal_destroy(mmi_signal_h handle); diff --git a/capi/mmi.h b/capi/mmi.h index 01d7240..289e85e 100644 --- a/capi/mmi.h +++ b/capi/mmi.h @@ -117,6 +117,7 @@ int mmi_initialize(void); * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_OPERATION_FAILED Operation failed * * @see mmi_initialize(void) @@ -133,6 +134,7 @@ int mmi_deinitialize(void); * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_state_changed_cb() @@ -149,6 +151,7 @@ int mmi_set_state_changed_cb(mmi_state_changed_cb callback, void *user_data); * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre A callback function must have been set using mmi_set_state_changed_cb() before calling this function. @@ -170,6 +173,7 @@ int mmi_unset_state_changed_cb(mmi_state_changed_cb callback); * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -199,6 +203,7 @@ int mmi_standard_workflow_instance_create(mmi_standard_workflow_type_e type, mmi * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -233,6 +238,7 @@ int mmi_custom_workflow_instance_create(mmi_workflow_h workflow, mmi_workflow_in * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created and activated before calling this function. @@ -252,6 +258,7 @@ int mmi_workflow_instance_destroy(mmi_workflow_instance_h instance); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created before calling this function. @@ -271,6 +278,7 @@ int mmi_workflow_instance_activate(mmi_workflow_instance_h instance); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created and activated before calling this function. @@ -290,6 +298,7 @@ int mmi_workflow_instance_deactivate(mmi_workflow_instance_h instance); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created before calling this function. @@ -309,6 +318,7 @@ int mmi_workflow_instance_set_attribute(mmi_workflow_instance_h instance, mmi_at * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created and activated before calling this function. @@ -330,6 +340,7 @@ int mmi_workflow_instance_emit_signal(mmi_workflow_instance_h instance, mmi_sign * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created before calling this function. @@ -351,6 +362,7 @@ int mmi_workflow_instance_set_output_cb(mmi_workflow_instance_h instance, const * * @return @c 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. * * @pre The workflow instance must have been created before calling this function. diff --git a/capi/node/mmi-node-types.h b/capi/node/mmi-node-types.h index 1e0ca41..8ad5ca8 100644 --- a/capi/node/mmi-node-types.h +++ b/capi/node/mmi-node-types.h @@ -99,6 +99,7 @@ enum mmi_node_action_type_e { * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -127,6 +128,7 @@ int mmi_node_create_source(mmi_node_source_type_e type, mmi_node_h *node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The source node must be created using mmi_node_create_source(). @@ -147,6 +149,7 @@ int mmi_node_get_source_type(mmi_node_h node, mmi_node_source_type_e *type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -175,6 +178,7 @@ int mmi_node_create_processor(mmi_node_processor_type_e type, mmi_node_h *node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The processor node must be created using mmi_node_create_processor(). @@ -195,6 +199,7 @@ int mmi_node_get_processor_type(mmi_node_h node, mmi_node_processor_type_e *type * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -224,6 +229,7 @@ int mmi_node_create_logic(mmi_node_logic_type_e type, mmi_node_h *node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The logic node must be created using mmi_node_create_logic(). @@ -244,6 +250,7 @@ int mmi_node_get_logic_type(mmi_node_h node, mmi_node_logic_type_e *type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -269,6 +276,7 @@ int mmi_node_create_controller(mmi_node_controller_type_e type, mmi_node_h *node * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_node_get_controller_type(mmi_node_h node, mmi_node_controller_type_e *type); @@ -284,6 +292,7 @@ int mmi_node_get_controller_type(mmi_node_h node, mmi_node_controller_type_e *ty * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -309,6 +318,7 @@ int mmi_node_create_action(mmi_node_action_type_e type, mmi_node_h *node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_node_get_action_type(mmi_node_h node, mmi_node_action_type_e *type); @@ -324,6 +334,7 @@ int mmi_node_get_action_type(mmi_node_h node, mmi_node_action_type_e *type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -351,6 +362,7 @@ int mmi_node_create_custom(const char *custom_type_id, mmi_node_h *node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example diff --git a/capi/node/mmi-node.h b/capi/node/mmi-node.h index b46e83b..3ce927c 100644 --- a/capi/node/mmi-node.h +++ b/capi/node/mmi-node.h @@ -76,6 +76,7 @@ typedef void* mmi_node_instance_h; * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_initialized_cb)(mmi_node_instance_h instance, void *user_data); @@ -92,6 +93,7 @@ typedef int (*mmi_node_initialized_cb)(mmi_node_instance_h instance, void *user_ * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_deinitialized_cb)(mmi_node_instance_h instance, void *user_data); @@ -111,6 +113,7 @@ typedef int (*mmi_node_deinitialized_cb)(mmi_node_instance_h instance, void *use * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_attribute_set_cb)(mmi_node_instance_h instance, mmi_attribute_h attribute, void *user_data); @@ -127,6 +130,7 @@ typedef int (*mmi_node_attribute_set_cb)(mmi_node_instance_h instance, mmi_attri * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_activated_cb)(mmi_node_instance_h instance, void *user_data); @@ -143,6 +147,7 @@ typedef int (*mmi_node_activated_cb)(mmi_node_instance_h instance, void *user_da * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_deactivated_cb)(mmi_node_instance_h instance, void *user_data); @@ -162,6 +167,7 @@ typedef int (*mmi_node_deactivated_cb)(mmi_node_instance_h instance, void *user_ * * @return An integer value indicating the result of the callback execution. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ typedef int (*mmi_node_signal_received_cb)(mmi_node_instance_h instance, mmi_signal_h signal, void *user_data); @@ -184,6 +190,7 @@ typedef struct mmi_node_s* mmi_node_h; * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_initialized_cb() @@ -201,6 +208,7 @@ int mmi_node_set_initialized_cb(mmi_node_h node, mmi_node_initialized_cb callbac * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_deinitialized_cb() @@ -218,6 +226,7 @@ int mmi_node_set_deinitialized_cb(mmi_node_h node, mmi_node_deinitialized_cb cal * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_attribute_set_cb() @@ -235,6 +244,7 @@ int mmi_node_set_attribute_set_cb(mmi_node_h node, mmi_node_attribute_set_cb cal * * @return 0 on success, otherwise a negative error value * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_activated_cb() @@ -252,6 +262,7 @@ int mmi_node_set_activated_cb(mmi_node_h node, mmi_node_activated_cb callback, v * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_deactivated_cb() @@ -270,6 +281,7 @@ int mmi_node_set_deactivated_cb(mmi_node_h node, mmi_node_deactivated_cb callbac * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_signal_received_cb() @@ -287,6 +299,7 @@ int mmi_node_set_signal_received_cb(mmi_node_h node, mmi_node_signal_received_cb * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port must be created before adding it to the node. @@ -308,6 +321,7 @@ int mmi_node_add_port(mmi_node_h node, mmi_port_h port); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist and contain ports. @@ -334,6 +348,7 @@ int mmi_node_find_port(mmi_node_h node, mmi_port_type_e port_type, const char *p * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist. @@ -351,6 +366,7 @@ int mmi_node_get_type(mmi_node_h node, mmi_node_type_e *type); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist. @@ -371,6 +387,7 @@ int mmi_node_get_port_count(mmi_node_h node, size_t *port_count); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist and contain ports. @@ -396,6 +413,7 @@ int mmi_node_get_port(mmi_node_h node, size_t index, mmi_port_h *port); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist and be properly initialized. @@ -414,6 +432,7 @@ int mmi_node_register(mmi_node_h node); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist. @@ -441,6 +460,7 @@ int mmi_node_clone(mmi_node_h node, mmi_node_h *cloned); * * @return An integer value indicating the result of the operation. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The node must exist. @@ -458,6 +478,7 @@ int mmi_node_destroy(mmi_node_h node); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -477,6 +498,7 @@ int mmi_node_instance_set_attribute(mmi_node_instance_h instance, mmi_attribute_ * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -500,6 +522,7 @@ int mmi_node_instance_find_port_instance(mmi_node_instance_h node_instance, mmi_ * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -524,6 +547,7 @@ int mmi_node_instance_find_by_port_instance(mmi_port_instance_h port_instance, m * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @par Example @@ -545,6 +569,7 @@ int mmi_node_instance_find_sibling_port_instance(mmi_port_instance_h instance, c * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_node_instance_emit_signal(mmi_node_instance_h instance, mmi_signal_h signal); @@ -558,6 +583,7 @@ int mmi_node_instance_emit_signal(mmi_node_instance_h instance, mmi_signal_h sig * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter */ int mmi_node_instance_update_pending_activation_result(mmi_error_e result); diff --git a/capi/node/mmi-port.h b/capi/node/mmi-port.h index c1391e1..f72f197 100644 --- a/capi/node/mmi-port.h +++ b/capi/node/mmi-port.h @@ -90,6 +90,7 @@ typedef struct mmi_port_s* mmi_port_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -119,6 +120,7 @@ int mmi_port_create(mmi_port_h *port); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -150,6 +152,7 @@ int mmi_port_get_name(mmi_port_h port, char **name, size_t *length); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -169,6 +172,7 @@ int mmi_port_get_type(mmi_port_h port, mmi_port_type_e *type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -188,6 +192,7 @@ int mmi_port_get_data_type(mmi_port_h port, mmi_data_type_e *data_type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -206,6 +211,7 @@ int mmi_port_set_name(mmi_port_h port, const char *name); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -225,6 +231,7 @@ int mmi_port_set_type(mmi_port_h port, mmi_port_type_e type); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @pre The port handle must be valid and initialized. @@ -245,6 +252,7 @@ int mmi_port_set_data_type(mmi_port_h port, mmi_data_type_e data_type); * * @return @c 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful. + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter. */ int mmi_port_set_input_data_received_cb(mmi_port_h port, mmi_port_input_data_received_cb callback, void *user_data); @@ -260,6 +268,7 @@ int mmi_port_set_input_data_received_cb(mmi_port_h port, mmi_port_input_data_rec * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -291,6 +300,7 @@ int mmi_port_clone(mmi_port_h port, mmi_port_h *cloned); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ @@ -306,6 +316,7 @@ int mmi_port_destroy(mmi_port_h port); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory */ diff --git a/capi/workflow/mmi-workflow.h b/capi/workflow/mmi-workflow.h index ea24d66..2de8076 100644 --- a/capi/workflow/mmi-workflow.h +++ b/capi/workflow/mmi-workflow.h @@ -68,6 +68,7 @@ typedef struct mmi_workflow_s* mmi_workflow_h; * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -95,6 +96,7 @@ int mmi_workflow_create(mmi_workflow_h *workflow); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_standard_workflow_type_e @@ -112,6 +114,7 @@ int mmi_workflow_set_type(mmi_workflow_h workflow, mmi_standard_workflow_type_e * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_standard_workflow_type_e @@ -130,6 +133,7 @@ int mmi_workflow_get_type(mmi_workflow_h workflow, mmi_standard_workflow_type_e * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_h @@ -149,6 +153,7 @@ int mmi_workflow_node_add(mmi_workflow_h workflow, const char *node_name, mmi_no * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_node_h @@ -167,6 +172,7 @@ int mmi_workflow_link_nodes_by_names(mmi_workflow_h workflow, const char *from_n * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_attribute_h @@ -183,6 +189,7 @@ int mmi_workflow_attribute_assign(mmi_workflow_h workflow, const char *attribute * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * * @see mmi_attribute_h @@ -201,6 +208,7 @@ int mmi_workflow_attribute_set_default_value(mmi_workflow_h workflow, mmi_attrib * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -220,6 +228,7 @@ int mmi_workflow_signal_assign(mmi_workflow_h workflow, const char *signal_name, * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -238,6 +247,7 @@ int mmi_workflow_output_assign(mmi_workflow_h workflow, const char *workflow_out * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -255,6 +265,7 @@ int mmi_workflow_output_assign_by_port(mmi_workflow_h workflow, const char *work * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -273,6 +284,7 @@ int mmi_standard_workflow_register(mmi_workflow_h workflow); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -302,6 +314,7 @@ int mmi_workflow_clone(mmi_workflow_h workflow, mmi_workflow_h *cloned); * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * @@ -328,6 +341,7 @@ int mmi_workflow_create_from_script(const char *script, mmi_workflow_h *workflow * * @return 0 on success, otherwise a negative error value. * @retval #MMI_ERROR_NONE Successful + * @retval #MMI_ERROR_NOT_SUPPORTED Not supported * @retval #MMI_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MMI_ERROR_OUT_OF_MEMORY Out of memory * diff --git a/doc/mmi-doc.h b/doc/mmi-doc.h index 3784faa..66fc2f3 100644 --- a/doc/mmi-doc.h +++ b/doc/mmi-doc.h @@ -91,6 +91,16 @@ * This callback is used to notify that an error has occurred * * + * + * @section CAPI_UIX_MMI_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - %http://tizen.org/feature/multimodal_interaction + * + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from Feature Element. + * */ /**