Name: capi-base-utils
Summary: Base Utils
-Version: 1.0.1
+Version: 1.0.2
Release: 1
Group: Base
License: Apache-2.0 and ICU
/**
* @brief Returns the timezone data version currently used by I18N.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @return the version string, such as "2007f"
+ * @exception #I18N_ERROR_NONE Successful
*/
const char* i18n_timezone_get_tzdata_version(void);
/**
* @brief Definition of context length.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @internal This is internal API
*/
#define I18N_U_PARSE_CONTEXT_LEN 16
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct {
- int32_t line;
- int32_t offset;
- i18n_uchar preContext[I18N_U_PARSE_CONTEXT_LEN];
- i18n_uchar postContext[I18N_U_PARSE_CONTEXT_LEN];
+ int32_t line; /**< The line on which the error occured. */
+ int32_t offset; /**< The character offset to the error */
+ i18n_uchar preContext[I18N_U_PARSE_CONTEXT_LEN]; /**< Textual context before the error */
+ i18n_uchar postContext[I18N_U_PARSE_CONTEXT_LEN]; /**< The error itself and/or textual context after the error */
} i18n_uparse_error_s;
/**
* @brief Gets a locale for which text breaking information is available.
* @details A #i18n_ubreak_iterator_h in a locale returned by this function will perform the correct
* text breaking for the locale.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
* @param[in] index The index of the desired locale.
* @return A locale for which number text breaking information is available, or @c 0 if none.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @see i18n_ubrk_count_available()
*/
const char *i18n_ubrk_get_available (int32_t index);
* @brief Determines how many locales have text breaking information available.
* @details This function is most useful as determining the loop ending condition for
* calls to i18n_ubrk_get_available().
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
* @return The number of locales for which text breaking information is available.
+ * @exception #I18N_ERROR_NONE Successful
* @see i18n_ubrk_get_available()
*/
int32_t i18n_ubrk_count_available (void);
* @details The default is determined initially by querying the host operating system.
* It may be changed with i18n_ucalendar_set_default_timezone()
* or with the C++ TimeZone API.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[out] result A buffer to receive the result, or @c NULL
* @param[in] result_capacity The capacity of the @c result buffer
*
* @return The @c result string length, not including the terminating @c NULL.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in #i18n_error_code_e description.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid parameter
*/
int32_t i18n_ucalendar_get_default_timezone (i18n_uchar *result, int32_t result_capacity);
/**
* @brief Gets the ID of the calendar's time zone.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] result_length The maximum size of the @c result.
*
* @return The total buffer size needed; if greater than @c result_length, the output was truncated.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* @brief Gets a locale for which calendars are available.
* @details A #i18n_ucalendar_h in a locale returned by this function will contain
* the correct day and month names for the locale.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @param[in] locale_index The index of the desired locale.
*
* @return A locale for which calendars are available, or 0 if none.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid parameter
* @see i18n_ucalendar_count_available()
/**
* @brief Determines how many locales have calendars available.
* @details This function is most useful as determining the loop ending condition for calls to i18n_ucalendar_get_available().
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @return The number of locales for which calendars are available.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
* @see i18n_ucalendar_get_available()
*/
/**
* @brief Determines if a field in a #i18n_ucalendar_h is set.
* @details All fields are represented as 32-bit integers.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* #I18N_UCALENDAR_SECOND, #I18N_UCALENDAR_MILLISECOND, #I18N_UCALENDAR_ZONE_OFFSET,
* #I18N_UCALENDAR_DST_OFFSET.
* @return @c true if field is set, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @see i18n_ucalendar_get()
* @see i18n_ucalendar_set()
* @see i18n_ucalendar_clear_field()
/**
* @brief Determines a limit for a field in a #i18n_ucalendar_h.
* @details A limit is a maximum or minimum value for a field.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] type The desired critical point; one of #I18N_UCALENDAR_MINIMUM, #I18N_UCALENDAR_MAXIMUM,
* #I18N_UCALENDAR_GREATEST_MINIMUM, #I18N_UCALENDAR_LEAST_MAXIMUM, #I18N_UCALENDAR_ACTUAL_MINIMUM,
* #I18N_UCALENDAR_ACTUAL_MAXIMUM
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
/**
* @brief Gets the locale for this @c calendar object.
* @details You can choose between valid and actual locale.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The calendar object
* @param[in] type Type of the locale we're looking for (valid or actual)
*
* @return The requested value.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Returns the timezone data version currently used by ICU.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @return The version string, such as "2007f".
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in #i18n_error_code_e description.
+ * @exception #I18N_ERROR_NONE Successful
*/
const char *i18n_ucalendar_get_tz_data_version (void);
/**
* @brief Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] id The input timezone ID to be canonicalized.
* @param[out] is_system_id Receives if the given @c id is a known system timezone ID.
*
* @return The result string length, not including the terminating NULL.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Gets the resource keyword value string designating the calendar type for the #i18n_ucalendar_h.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
*
* @return The resource keyword value string.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* the specified @c day_of_week, return the time at which the weekend ends. If
* i18n_ucalendar_get_day_of_week_type() returns some other #i18n_ucalendar_weekday_type_e
* for the specified @c day_of_week, it is an error condition (#I18N_ERROR_INVALID_PARAMETER).
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] day_of_week The day of the week whose type is desired (#I18N_UCALENDAR_SUNDAY..#I18N_UCALENDAR_SATURDAY).
*
* @return The milliseconds after midnight at which the weekend begins or ends.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Returns @c true if the given #i18n_udate is in the weekend in this calendar system.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] date The #i18n_udate in question.
*
* @return @c true if the given #i18n_udate is in the weekend in this calendar system, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* to the calendar's current date, in the time zone to which the calendar is currently set.
* @details If there is no known time zone transition of the requested type relative
* to the calendar's date, the function returns @c false.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* If the function returns @c false, the value set is unspecified.
*
* @return @c true if the given #i18n_udate is in the weekend in this calendar system, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* @param[in] locale_index The index of the desired locale.
*
* @return A locale for which date/time formatting patterns are available, or 0 if none.
- *
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
+
* @see i18n_udate_count_available()
*/
const char *i18n_udate_get_available ( int32_t locale_index );
*
* @return The total buffer size needed; if greater than result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
* @see i18n_udate_apply_pattern()
*
* @return The total buffer size needed; if greater than result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
* @see i18n_udate_count_symbols()
/**
* @brief Creates an empty generator, to be constructed with i18n_udatepg_add_pattern() etc.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[out] dtpg A pointer to the #i18n_udatepg_h handle.
/**
* @brief Creates a copy of a generator.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle to be copied. Must not be @c NULL.
* There are actually three available variables : {0} is the pattern so far,
* {1} is the element we are adding, and {2} is the name of the element. <br>
* This reflects the way that the CLDR data is organized.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle. Must not be @c NULL.
* @brief Sets the name of field, e.g. "era" in English for ERA.
* @details These are only used if the corresponding append_item_format is used, and if it contains a {2} variable.
* This reflects the way that the CLDR data is organized.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle. Must not be @c NULL.
* and its date time format is the default "{0} {1}". Then if the input skeleton is "MMMdhmm",
* there is not an exact match, so the input skeleton is broken up into two components "MMMd" and "hmm".
* There are close matches for those two skeletons, so the result is put together with this pattern, resulting in "d-MMM h:mm".
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
* For example, suppose that the input pattern is "hhmmssSSSS",
* and the best matching pattern internally is "H:mm:ss", and the decimal string is ",".
* Then the resulting pattern is modified to be "H:mm:ss,SSSS"
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg The #i18n_udate_format_h handle. Must not be @c NULL.
/**
* @brief Creates an #i18n_uenumeration_h for list of all the skeletons in canonical form.
* @details Call i18n_udatepg_get_pattern_for_skeleton() to get the corresponding pattern.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
/**
* @brief Creates an #i18n_uenumeration_h for list of all the base skeletons in canonical form.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
* Both this array and the pointers it contains are owned by I18N
* and should not be deleted or written through by the caller.
* The locale name is terminated by a null pointer.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] n The specific locale name index of the available locale list
*
* @return A specified locale name of all available locales
+ * @exception #I18N_ERROR_NONE Success
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
const char* i18n_ulocale_get_available ( int32_t n );
/**
* @brief Gets the size of the all available locale list.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @return The size of the locale list
+ * @exception #I18N_ERROR_NONE Success
*/
int32_t i18n_ulocale_count_available ( void );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_get_name ( const char *locale_id, char *name, int32_t name_capacity );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_canonicalize ( const char *locale_id, char *name, int32_t name_capacity );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_get_base_name ( const char *locale_id, char *name, int32_t name_capacity );
* @return The actual buffer size needed for the maximized locale. If it's
* greater than @a maximized_lacale_id_capacity, the returned ID will be truncated.
* On error, the return value is -1.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_ulocale_add_likely_subtags ( const char *locale_id, char *maximized_locale_id, int32_t maximized_locale_id_capacity );
* @return The actual buffer size needed for the minimized locale. If it's
* greater than @a minimized_locale_id_capacity, the returned ID will be truncated.
* On error, the return value is -1.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_ulocale_minimize_subtags ( const char *locale_id, char *minimized_locale_id, int32_t minimized_locale_id_capacity );
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The value of the parsed integer
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_parse (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The value of the parsed integer
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int64_t i18n_unumber_parse_int64 (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The value of the parsed double
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
double i18n_unumber_parse_double (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The length of the output string, not including any terminating NULL.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_parse_decimal (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos, char *out_buf, int32_t out_buf_length);
*
* @return The parsed double
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
double i18n_unumber_parse_double_currency (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos, i18n_uchar *currency);
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_get_text_attribute (const i18n_unumber_format_h fmt, i18n_unumber_format_text_attribute_e tag, i18n_uchar *result, int32_t result_length);
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_to_pattern (const i18n_unumber_format_h fmt, i18n_ubool is_pattern_localized, i18n_uchar *result, int32_t result_length);
*
* @return The locale name
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
const char *i18n_unumber_get_locale_by_type (const i18n_unumber_format_h fmt, i18n_ulocale_data_locale_type_e type);
* @details A collator will be created in the process, which will be owned by
* this search and will be deleted in i18n_usearch_destroy().
* @remarks Must release @a search_iter using i18n_usearch_destroy().
- *
- * The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] pattern The pattern for matching
*
* @retval #I18N_ERROR_NONE Successful
* @retval #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
- *
- * @exception #I18N_ERROR_NONE Successful
- * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int i18n_usearch_create_new ( const i18n_uchar *pattern, int32_t pattern_len, const i18n_uchar *text,
int32_t text_len, const char *locale, i18n_ubreak_iterator_h break_iter, i18n_usearch_h *search_iter);
* In code unit order, high BMP code points sort after supplementary code points because they are stored as pairs of surrogates which are at U+d800..U+dfff.\n
* This functions works with strings of different explicitly specified lengths unlike the ANSI C-like #i18n_ustring_compare() and i18n_ustring_mem_compare() etc.
* NULL-terminated strings are possible with length arguments of -1.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] s1 First source string.
* @details Casing is locale-dependent and context-sensitive.
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string\n The result will be zero-terminated if
* @details Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original. The source string and the destination buffer are allowed to overlap.
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
* Titlecasing uses a break iterator to find the first characters of words
* that are to be titlecased. It titlecases those characters and lowercases
* all others.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
- * The titlecase break iterator can be provided to customize arbitrary
+ * @remarks The titlecase break iterator can be provided to customize arbitrary
* styles, using rules and dictionaries beyond the standard iterators.
* It may be more efficient to always provide an iterator to avoid
* opening and closing one for each string.
* @param[in] locale The locale to consider, or "" for the root locale or @c NULL for the default locale.
* @return The length of the result string. It may be greater than dest_capacity. In that case,
* only some of the result were written to the destination buffer.
+ * @exception #I18N_ERROR_NONE Success
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @see i18n_ustring_to_title()
*/
* but there is an option for whether to include or exclude mappings for dotted I and dotless i.\n
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string\n
* @brief Convert a UTF-16 string to a wchar_t string.
* @details If it is known at compile time that wchar_t strings are in UTF-16 or UTF-32, then this function simply calls the fast, dedicated function for that.
* Otherwise, two conversions UTF-16 -> default charset -> wchar_t* are performed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
* @brief Convert a wchar_t string to UTF-16.
* @details If it is known at compile time that wchar_t strings are in UTF-16 or UTF-32, then this function simply calls the fast, dedicated function for that.
* Otherwise, two conversions wchar_t* -> default charset -> UTF-16 are performed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
-* Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
/**
* @brief Converts a UTF-16 string to UTF-8.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Converts a UTF-8 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* @brief Convert a UTF-16 string to UTF-8.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
* Same as #i18n_ustring_to_UTF8() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-8 string to UTF-16.
* @details Same as #i18n_ustring_from_UTF8() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* - Non-shortest forms are not detected and will result in "spoofing" output.\n
* For further performance improvement, if src_len is given (>=0), then it must be dest_capacity>=src_len.\n
* There is no inverse i18n_ustring_to_UTF8_lenient() function because there is practically no performance gain from not checking that a UTF-16 string is well-formed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-16 string to UTF-32.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-32 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-16 string to UTF-32.
* @details Same as #i18n_ustring_to_UTF32() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* @brief Convert a UTF-32 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
* Same as #i18n_ustring_from_UTF32() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Returns the timezone data version currently used by I18N.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @return the version string, such as "2007f"
+ * @exception #I18N_ERROR_NONE Successful
*/
const char* i18n_timezone_get_tzdata_version(void);
/**
* @brief Definition of context length.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @internal This is internal API
*/
#define I18N_U_PARSE_CONTEXT_LEN 16
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct {
- int32_t line;
- int32_t offset;
- i18n_uchar preContext[I18N_U_PARSE_CONTEXT_LEN];
- i18n_uchar postContext[I18N_U_PARSE_CONTEXT_LEN];
+ int32_t line; /**< The line on which the error occured. */
+ int32_t offset; /**< The character offset to the error */
+ i18n_uchar preContext[I18N_U_PARSE_CONTEXT_LEN]; /**< Textual context before the error */
+ i18n_uchar postContext[I18N_U_PARSE_CONTEXT_LEN]; /**< The error itself and/or textual context after the error */
} i18n_uparse_error_s;
/**
* @brief Gets a locale for which text breaking information is available.
* @details A #i18n_ubreak_iterator_h in a locale returned by this function will perform the correct
* text breaking for the locale.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
* @param[in] index The index of the desired locale.
* @return A locale for which number text breaking information is available, or @c 0 if none.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @see i18n_ubrk_count_available()
*/
const char *i18n_ubrk_get_available (int32_t index);
* @brief Determines how many locales have text breaking information available.
* @details This function is most useful as determining the loop ending condition for
* calls to i18n_ubrk_get_available().
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
* @return The number of locales for which text breaking information is available.
+ * @exception #I18N_ERROR_NONE Successful
* @see i18n_ubrk_get_available()
*/
int32_t i18n_ubrk_count_available (void);
* @details The default is determined initially by querying the host operating system.
* It may be changed with i18n_ucalendar_set_default_timezone()
* or with the C++ TimeZone API.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[out] result A buffer to receive the result, or @c NULL
* @param[in] result_capacity The capacity of the @c result buffer
*
* @return The @c result string length, not including the terminating @c NULL.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in #i18n_error_code_e description.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid parameter
*/
int32_t i18n_ucalendar_get_default_timezone (i18n_uchar *result, int32_t result_capacity);
/**
* @brief Gets the ID of the calendar's time zone.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] result_length The maximum size of the @c result.
*
* @return The total buffer size needed; if greater than @c result_length, the output was truncated.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* @brief Gets a locale for which calendars are available.
* @details A #i18n_ucalendar_h in a locale returned by this function will contain
* the correct day and month names for the locale.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @param[in] locale_index The index of the desired locale.
*
* @return A locale for which calendars are available, or 0 if none.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid parameter
* @see i18n_ucalendar_count_available()
/**
* @brief Determines how many locales have calendars available.
* @details This function is most useful as determining the loop ending condition for calls to i18n_ucalendar_get_available().
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @return The number of locales for which calendars are available.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
* @see i18n_ucalendar_get_available()
*/
/**
* @brief Determines if a field in a #i18n_ucalendar_h is set.
* @details All fields are represented as 32-bit integers.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* #I18N_UCALENDAR_SECOND, #I18N_UCALENDAR_MILLISECOND, #I18N_UCALENDAR_ZONE_OFFSET,
* #I18N_UCALENDAR_DST_OFFSET.
* @return @c true if field is set, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section.
* @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @see i18n_ucalendar_get()
* @see i18n_ucalendar_set()
* @see i18n_ucalendar_clear_field()
/**
* @brief Determines a limit for a field in a #i18n_ucalendar_h.
* @details A limit is a maximum or minimum value for a field.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] type The desired critical point; one of #I18N_UCALENDAR_MINIMUM, #I18N_UCALENDAR_MAXIMUM,
* #I18N_UCALENDAR_GREATEST_MINIMUM, #I18N_UCALENDAR_LEAST_MAXIMUM, #I18N_UCALENDAR_ACTUAL_MINIMUM,
* #I18N_UCALENDAR_ACTUAL_MAXIMUM
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
/**
* @brief Gets the locale for this @c calendar object.
* @details You can choose between valid and actual locale.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The calendar object
* @param[in] type Type of the locale we're looking for (valid or actual)
*
* @return The requested value.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Returns the timezone data version currently used by ICU.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @return The version string, such as "2007f".
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in #i18n_error_code_e description.
+ * @exception #I18N_ERROR_NONE Successful
*/
const char *i18n_ucalendar_get_tz_data_version (void);
/**
* @brief Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] id The input timezone ID to be canonicalized.
* @param[out] is_system_id Receives if the given @c id is a known system timezone ID.
*
* @return The result string length, not including the terminating NULL.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Gets the resource keyword value string designating the calendar type for the #i18n_ucalendar_h.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
*
* @return The resource keyword value string.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* the specified @c day_of_week, return the time at which the weekend ends. If
* i18n_ucalendar_get_day_of_week_type() returns some other #i18n_ucalendar_weekday_type_e
* for the specified @c day_of_week, it is an error condition (#I18N_ERROR_INVALID_PARAMETER).
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] day_of_week The day of the week whose type is desired (#I18N_UCALENDAR_SUNDAY..#I18N_UCALENDAR_SATURDAY).
*
* @return The milliseconds after midnight at which the weekend begins or ends.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
/**
* @brief Returns @c true if the given #i18n_udate is in the weekend in this calendar system.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* @param[in] date The #i18n_udate in question.
*
* @return @c true if the given #i18n_udate is in the weekend in this calendar system, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* to the calendar's current date, in the time zone to which the calendar is currently set.
* @details If there is no known time zone transition of the requested type relative
* to the calendar's date, the function returns @c false.
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exceptions section and
+ * #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] calendar The #i18n_ucalendar_h to query.
* If the function returns @c false, the value set is unspecified.
*
* @return @c true if the given #i18n_udate is in the weekend in this calendar system, @c false otherwise.
- * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are described in Exceptions section and
- * #i18n_error_code_e description.
* @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
* @param[in] locale_index The index of the desired locale.
*
* @return A locale for which date/time formatting patterns are available, or 0 if none.
- *
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
+
* @see i18n_udate_count_available()
*/
const char *i18n_udate_get_available ( int32_t locale_index );
*
* @return The total buffer size needed; if greater than result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
* @see i18n_udate_apply_pattern()
*
* @return The total buffer size needed; if greater than result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*
* @see i18n_udate_count_symbols()
/**
* @brief Creates an empty generator, to be constructed with i18n_udatepg_add_pattern() etc.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[out] dtpg A pointer to the #i18n_udatepg_h handle.
/**
* @brief Creates a copy of a generator.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle to be copied. Must not be @c NULL.
* There are actually three available variables : {0} is the pattern so far,
* {1} is the element we are adding, and {2} is the name of the element. <br>
* This reflects the way that the CLDR data is organized.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle. Must not be @c NULL.
* @brief Sets the name of field, e.g. "era" in English for ERA.
* @details These are only used if the corresponding append_item_format is used, and if it contains a {2} variable.
* This reflects the way that the CLDR data is organized.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udatepg_h handle. Must not be @c NULL.
* and its date time format is the default "{0} {1}". Then if the input skeleton is "MMMdhmm",
* there is not an exact match, so the input skeleton is broken up into two components "MMMd" and "hmm".
* There are close matches for those two skeletons, so the result is put together with this pattern, resulting in "d-MMM h:mm".
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
* For example, suppose that the input pattern is "hhmmssSSSS",
* and the best matching pattern internally is "H:mm:ss", and the decimal string is ",".
* Then the resulting pattern is modified to be "H:mm:ss,SSSS"
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg The #i18n_udate_format_h handle. Must not be @c NULL.
/**
* @brief Creates an #i18n_uenumeration_h for list of all the skeletons in canonical form.
* @details Call i18n_udatepg_get_pattern_for_skeleton() to get the corresponding pattern.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
/**
* @brief Creates an #i18n_uenumeration_h for list of all the base skeletons in canonical form.
- * @remarks The specific error code can be obtained using the get_last_result() method.
- * Error codes are described in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] dtpg An #i18n_udate_format_h handle. Must not be @c NULL.
* Both this array and the pointers it contains are owned by I18N
* and should not be deleted or written through by the caller.
* The locale name is terminated by a null pointer.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] n The specific locale name index of the available locale list
*
* @return A specified locale name of all available locales
+ * @exception #I18N_ERROR_NONE Success
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
const char* i18n_ulocale_get_available ( int32_t n );
/**
* @brief Gets the size of the all available locale list.
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exceptions section.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @return The size of the locale list
+ * @exception #I18N_ERROR_NONE Success
*/
int32_t i18n_ulocale_count_available ( void );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_get_name ( const char *locale_id, char *name, int32_t name_capacity );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_canonicalize ( const char *locale_id, char *name, int32_t name_capacity );
*
* @return The actual buffer size needed for the full name. If it's greater than @a name_capacity,
* the returned full name will be truncated.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_BUFFER_OVERFLOW A result would not fit in the supplied buffer
*/
int32_t i18n_ulocale_get_base_name ( const char *locale_id, char *name, int32_t name_capacity );
* @return The actual buffer size needed for the maximized locale. If it's
* greater than @a maximized_lacale_id_capacity, the returned ID will be truncated.
* On error, the return value is -1.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_ulocale_add_likely_subtags ( const char *locale_id, char *maximized_locale_id, int32_t maximized_locale_id_capacity );
* @return The actual buffer size needed for the minimized locale. If it's
* greater than @a minimized_locale_id_capacity, the returned ID will be truncated.
* On error, the return value is -1.
+ * @exception #I18N_ERROR_NONE Successful
+ * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_ulocale_minimize_subtags ( const char *locale_id, char *minimized_locale_id, int32_t minimized_locale_id_capacity );
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
* @exception #I18N_WARNING_STRING_NOT_TERMINATED If the formatted number fits into @a result but cannot be NULL-terminated (<code>length == result_length</code>)
* @exception #I18N_ERROR_BUFFER_OVERFLOW If the formatted number doesn't fit into the @a result buffer
*
* @return The value of the parsed integer
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_parse (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The value of the parsed integer
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int64_t i18n_unumber_parse_int64 (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The value of the parsed double
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
double i18n_unumber_parse_double (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos);
*
* @return The length of the output string, not including any terminating NULL.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_parse_decimal (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos, char *out_buf, int32_t out_buf_length);
*
* @return The parsed double
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
double i18n_unumber_parse_double_currency (const i18n_unumber_format_h fmt, const i18n_uchar *text, int32_t text_length, int32_t *parse_pos, i18n_uchar *currency);
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_get_text_attribute (const i18n_unumber_format_h fmt, i18n_unumber_format_text_attribute_e tag, i18n_uchar *result, int32_t result_length);
*
* @return The total buffer size needed; if greater than @a result_length, the output was truncated.
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int32_t i18n_unumber_to_pattern (const i18n_unumber_format_h fmt, i18n_ubool is_pattern_localized, i18n_uchar *result, int32_t result_length);
*
* @return The locale name
*
+ * @exception #I18N_ERROR_NONE Successful
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
const char *i18n_unumber_get_locale_by_type (const i18n_unumber_format_h fmt, i18n_ulocale_data_locale_type_e type);
* @details A collator will be created in the process, which will be owned by
* this search and will be deleted in i18n_usearch_destroy().
* @remarks Must release @a search_iter using i18n_usearch_destroy().
- *
- * The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen 2.3.1
*
* @param[in] pattern The pattern for matching
*
* @retval #I18N_ERROR_NONE Successful
* @retval #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
- *
- * @exception #I18N_ERROR_NONE Successful
- * @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
*/
int i18n_usearch_create_new ( const i18n_uchar *pattern, int32_t pattern_len, const i18n_uchar *text,
int32_t text_len, const char *locale, i18n_ubreak_iterator_h break_iter, i18n_usearch_h *search_iter);
* In code unit order, high BMP code points sort after supplementary code points because they are stored as pairs of surrogates which are at U+d800..U+dfff.\n
* This functions works with strings of different explicitly specified lengths unlike the ANSI C-like #i18n_ustring_compare() and i18n_ustring_mem_compare() etc.
* NULL-terminated strings are possible with length arguments of -1.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] s1 First source string.
* @details Casing is locale-dependent and context-sensitive.
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string\n The result will be zero-terminated if
* @details Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original. The source string and the destination buffer are allowed to overlap.
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
* @param[in] locale The locale to consider, or "" for the root locale or @c NULL for the default locale.
* @return The length of the result string. It may be greater than dest_capacity. In that case,
* only some of the result were written to the destination buffer.
+ * @exception #I18N_ERROR_NONE Success
* @exception #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @see i18n_ustring_to_title()
*/
int32_t i18n_ustring_to_title_new ( i18n_uchar *dest, int32_t dest_capacity, const i18n_uchar *src, int32_t src_len, i18n_ubreak_iterator_h title_iter, const char *locale);
* but there is an option for whether to include or exclude mappings for dotted I and dotless i.\n
* The result may be longer or shorter than the original.
* The source string and the destination buffer are allowed to overlap.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string\n
* @brief Convert a UTF-16 string to a wchar_t string.
* @details If it is known at compile time that wchar_t strings are in UTF-16 or UTF-32, then this function simply calls the fast, dedicated function for that.
* Otherwise, two conversions UTF-16 -> default charset -> wchar_t* are performed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
* @brief Convert a wchar_t string to UTF-16.
* @details If it is known at compile time that wchar_t strings are in UTF-16 or UTF-32, then this function simply calls the fast, dedicated function for that.
* Otherwise, two conversions wchar_t* -> default charset -> UTF-16 are performed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
-* Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string. The result will be zero-terminated if the buffer is large enough.
/**
* @brief Converts a UTF-16 string to UTF-8.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Converts a UTF-8 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* @brief Convert a UTF-16 string to UTF-8.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
* Same as #i18n_ustring_to_UTF8() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-8 string to UTF-16.
* @details Same as #i18n_ustring_from_UTF8() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* - Non-shortest forms are not detected and will result in "spoofing" output.\n
* For further performance improvement, if src_len is given (>=0), then it must be dest_capacity>=src_len.\n
* There is no inverse i18n_ustring_to_UTF8_lenient() function because there is practically no performance gain from not checking that a UTF-16 string is well-formed.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-16 string to UTF-32.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-32 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
/**
* @brief Convert a UTF-16 string to UTF-32.
* @details Same as #i18n_ustring_to_UTF32() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
* @brief Convert a UTF-32 string to UTF-16.
* @details If the input string is not well-formed, then the #I18N_ERROR_INVALID_CHAR_FOUND error code is set.
* Same as #i18n_ustring_from_UTF32() except for the additional sub_char which is output for illegal input sequences, instead of stopping with the #I18N_ERROR_INVALID_CHAR_FOUND error code.
- * @remarks The specific error code can be also obtained using the get_last_result() method.
- * Error codes are described in Exceptions section and in #i18n_error_code_e description.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[out] dest A buffer for the result string.\n
return NULL;
}
+ set_last_result(I18N_ERROR_NONE);
return udatpg_getDateTimeFormat((UDateTimePatternGenerator *)dtpg, pattern_length);
- return I18N_ERROR_NONE;
}
int i18n_udatepg_set_decimal ( i18n_udatepg_h dtpg, const i18n_uchar *decimal, int32_t length )
int32_t i18n_ulocale_count_available (void)
{
+ set_last_result(I18N_ERROR_NONE);
return uloc_countAvailable();
}
i18n_error_code_e i18n_error;
ERR_MAPPING(icu_error, i18n_error);
- set_last_result(i18n_error);
return i18n_error;
}
i18n_error_code_e i18n_error;
ERR_MAPPING(icu_error, i18n_error);
- set_last_result(i18n_error);
return i18n_error;
}
int i18n_uset_clone ( const i18n_uset_h set, i18n_uset_h *set_clone )
{
- set_last_result(I18N_ERROR_NONE);
if (set == NULL || set_clone == NULL) {
return I18N_ERROR_INVALID_PARAMETER;
}
int i18n_uset_freeze ( i18n_uset_h set )
{
- set_last_result(I18N_ERROR_NONE);
if (set == NULL) {
return I18N_ERROR_INVALID_PARAMETER;
}
int i18n_uset_clone_as_thawed ( const i18n_uset_h set, i18n_uset_h *set_copy )
{
- set_last_result(I18N_ERROR_NONE);
if (set == NULL || set_copy == NULL) {
return I18N_ERROR_INVALID_PARAMETER;
}
int i18n_uset_set ( i18n_uset_h set, i18n_uchar32 start, i18n_uchar32 end )
{
- set_last_result(I18N_ERROR_NONE);
if (set == NULL) {
return I18N_ERROR_INVALID_PARAMETER;
}
projects / platform / core / api / base-utils.git / commitdiff