Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/udatpg_8h.html below:

ICU 77.1: i18n/unicode/udatpg.h File Reference

C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h). More...

Go to the source code of this file.

C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h).

UDateTimePatternGenerator provides flexible generation of date format patterns, like "yy-MM-dd". The user can build up the generator by adding successive patterns. Once that is done, a query can be made using a "skeleton", which is a pattern which just includes the desired fields and lengths. The generator will return the "best fit" pattern corresponding to that skeleton.

The main method people will use is udatpg_getBestPattern, since normally UDateTimePatternGenerator is pre-built with data from a particular locale. However, generators can be built directly from other data as well.

Issue: may be useful to also have a function that returns the list of fields in a pattern, in order, since we have that internally. That would be useful for getting the UI order of field elements.

Definition in file udatpg.h.

Field number constants for udatpg_getAppendItemFormats() and similar functions.

These constants are separate from UDateFormatField despite semantic overlap because some fields are merged for the date/time pattern generator.

Stable:

ICU 3.8

Opaque type for a date/time pattern generator object.

Stable:

ICU 3.8

Definition at line 51 of file udatpg.h.

Masks to control forcing the length of specified fields in the returned pattern to match those in the skeleton (when this would not happen otherwise).

These may be combined to force the length of multiple fields. Used with udatpg_getBestPatternWithOptions, udatpg_replaceFieldTypesWithOptions.

Stable:

ICU 4.4

Status return values from udatpg_addPattern().

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

One more than the highest normal UDateTimePatternConflict value.

Deprecated:

ICU 58 The numeric value may change over time, see ICU ticket #12420.

Definition at line 143 of file udatpg.h.

Field number constants for udatpg_getAppendItemFormats() and similar functions.

These constants are separate from UDateFormatField despite semantic overlap because some fields are merged for the date/time pattern generator.

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

Stable:

ICU 3.8

One more than the highest normal UDateTimePatternField value.

Deprecated:

ICU 58 The numeric value may change over time, see ICU ticket #12420.

Definition at line 59 of file udatpg.h.

Masks to control forcing the length of specified fields in the returned pattern to match those in the skeleton (when this would not happen otherwise).

These may be combined to force the length of multiple fields. Used with udatpg_getBestPatternWithOptions, udatpg_replaceFieldTypesWithOptions.

Stable:

ICU 4.4

Stable:

ICU 4.4

Stable:

ICU 4.4

Internal:

Do not use.

This API is for internal use only. ICU 4.4

Internal:

Do not use.

This API is for internal use only. ICU 4.4

Stable:

ICU 4.4

Definition at line 124 of file udatpg.h.

Adds a pattern to the generator.

If the pattern has the same skeleton as an existing pattern, and the override parameter is set, then the previous value is overridden. Otherwise, the previous value is retained. In either case, the conflicting status is set and previous vale is stored in conflicting pattern.

Note that single-field patterns (like "MMM") are automatically added, and don't need to be added explicitly!

Parameters

dtpg a pointer to UDateTimePatternGenerator. pattern input pattern, such as "dd/MMM" patternLength the length of pattern. override When existing values are to be overridden use true, otherwise use false. conflictingPattern Previous pattern with the same skeleton. capacity the capacity of conflictingPattern. pLength a pointer to the length of conflictingPattern. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

conflicting status. The value could be UDATPG_NO_CONFLICT, UDATPG_BASE_CONFLICT or UDATPG_CONFLICT.

Stable:

ICU 3.8

Create a copy pf a generator.

Parameters

dtpg a pointer to UDateTimePatternGenerator to be copied. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

a pointer to a new UDateTimePatternGenerator.

Stable:

ICU 3.8

Close a generator.

Parameters

dtpg a pointer to UDateTimePatternGenerator.

Stable:

ICU 3.8

Getter corresponding to setAppendItemFormat.

Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments.

Parameters

dtpg A pointer to UDateTimePatternGenerator. field UDateTimePatternField, such as UDATPG_ERA_FIELD pLength A pointer that will receive the length of appendItemFormat.

Returns

appendItemFormat for field.

Stable:

ICU 3.8

Getter corresponding to setAppendItemNames.

Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments. Note: The more general function for getting date/time field display names is udatpg_getFieldDisplayName.

Parameters

dtpg a pointer to UDateTimePatternGenerator. field UDateTimePatternField, such as UDATPG_ERA_FIELD pLength A pointer that will receive the length of the name for field.

Returns

name for field

See also

udatpg_getFieldDisplayName

Stable:

ICU 3.8

Get a unique base skeleton from a given pattern.

This is the same as the skeleton, except that differences in length are minimized so as to only preserve the difference between string and numeric form. So for example, both "MMM-dd" and "d/MMM" produce the skeleton "MMMd" (notice the single d).

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

unusedDtpg a pointer to UDateTimePatternGenerator. This parameter is no longer used. Callers may pass NULL. pattern input pattern, such as "dd/MMM". length the length of pattern. baseSkeleton such as "Md" capacity the capacity of base skeleton. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of baseSkeleton.

Stable:

ICU 3.8

Get the best pattern matching the input skeleton.

It is guaranteed to have all of the fields in the skeleton.

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

dtpg a pointer to UDateTimePatternGenerator. skeleton The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. length the length of skeleton bestPattern The best pattern found from the given skeleton. capacity the capacity of bestPattern. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of bestPattern.

Stable:

ICU 3.8

Get the best pattern matching the input skeleton.

It is guaranteed to have all of the fields in the skeleton.

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

dtpg a pointer to UDateTimePatternGenerator. skeleton The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. length the length of skeleton options Options for forcing the length of specified fields in the returned pattern to match those in the skeleton (when this would not happen otherwise). For default behavior, use UDATPG_MATCH_NO_OPTIONS. bestPattern The best pattern found from the given skeleton. capacity the capacity of bestPattern. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of bestPattern.

Stable:

ICU 4.4

Getter corresponding to setDateTimeFormat.

There are four DateTimeFormats in a UDateTimePatternGenerator object, corresponding to date styles UDAT_FULL..UDAT_SHORT. This method gets the style for UDAT_MEDIUM (the default). To get them individually, see udatpg_getDateTimeFormatForStyle.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pLength A pointer that will receive the length of the format

Returns

dateTimeFormat.

Stable:

ICU 3.8

Getter corresponding to udatpg_setDateTimeFormatForStyle.

Parameters

udtpg a pointer to the UDateTimePatternGenerator style one of UDAT_FULL..UDAT_SHORT. Error if out of range. pLength a pointer that will receive the length of the format. May be NULL if length is not desired. pErrorCode a pointer to the UErrorCode (in/out parameter); if no failure status is already set, it will be set according to result of the function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range).

Returns

pointer to the current dateTimeFormat (0 terminated) for the specified style, or empty string in case of error. The pointer and its contents may no longer be valid if udatpg_setDateTimeFormat is called, or udatpg_setDateTimeFormatForStyle for the same style is called, or the UDateTimePatternGenerator object is closed.

Stable:

ICU 71

Getter corresponding to setDecimal.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pLength A pointer that will receive the length of the decimal string.

Returns

corresponding to the decimal point.

Stable:

ICU 3.8

Return the default hour cycle for a locale.

Uses the locale that the UDateTimePatternGenerator was initially created with.

Cannot be used on an empty UDateTimePatternGenerator instance.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call. Set to U_UNSUPPORTED_ERROR if used on an empty instance.

Returns

the default hour cycle.

Stable:

ICU 67

The general interface to get a display name for a particular date/time field, in one of several possible display widths.

Parameters

dtpg A pointer to the UDateTimePatternGenerator object with the localized display names. field The desired UDateTimePatternField, such as UDATPG_ERA_FIELD. width The desired UDateTimePGDisplayWidth, such as UDATPG_ABBREVIATED. fieldName A pointer to a buffer to receive the NULL-terminated display name. If the name fits into fieldName but cannot be NULL-terminated (length == capacity) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the name doesn't fit into fieldName then the error code is set to U_BUFFER_OVERFLOW_ERROR. capacity The size of fieldName (in UChars). pErrorCode A pointer to a UErrorCode to receive any errors

Returns

The full length of the name; if greater than capacity, fieldName contains a truncated result.

Stable:

ICU 61

Get the pattern corresponding to a given skeleton.

Parameters

dtpg a pointer to UDateTimePatternGenerator. skeleton skeletonLength pointer to the length of skeleton. pLength pointer to the length of return pattern.

Returns

pattern corresponding to a given skeleton.

Stable:

ICU 3.8

Get a unique skeleton from a given pattern.

For example, both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd".

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

unusedDtpg a pointer to UDateTimePatternGenerator. This parameter is no longer used. Callers may pass NULL. pattern input pattern, such as "dd/MMM". length the length of pattern. skeleton such as "MMMdd" capacity the capacity of skeleton. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of skeleton.

Stable:

ICU 3.8

Open a generator according to a given locale.

Parameters

locale pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

a pointer to UDateTimePatternGenerator.

Stable:

ICU 3.8

Return a UEnumeration list of all the base skeletons in canonical form.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

a UEnumeration list of all the base skeletons The caller must close the object.

Stable:

ICU 3.8

Open an empty generator, to be constructed with udatpg_addPattern(...) etc.

Parameters

pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

a pointer to UDateTimePatternGenerator.

Stable:

ICU 3.8

Return a UEnumeration list of all the skeletons in canonical form.

Call udatpg_getPatternForSkeleton() to get the corresponding pattern.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call

Returns

a UEnumeration list of all the skeletons The caller must close the object.

Stable:

ICU 3.8

Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.

That is, if you supply a pattern like "d-M H:m", and a skeleton of "MMMMddhhmm", then the input pattern is adjusted to be "dd-MMMM hh:mm". This is used internally to get the best match for the input skeleton, but can also be used externally.

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pattern Input pattern patternLength the length of input pattern. skeleton skeletonLength the length of input skeleton. dest pattern adjusted to match the skeleton fields widths and subtypes. destCapacity the capacity of dest. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of dest.

Stable:

ICU 3.8

Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.

That is, if you supply a pattern like "d-M H:m", and a skeleton of "MMMMddhhmm", then the input pattern is adjusted to be "dd-MMMM hh:mm". This is used internally to get the best match for the input skeleton, but can also be used externally.

Note that this function uses a non-const UDateTimePatternGenerator: It uses a stateful pattern parser which is set up for each generator object, rather than creating one for each function call. Consecutive calls to this function do not affect each other, but this function cannot be used concurrently on a single generator object.

Parameters

dtpg a pointer to UDateTimePatternGenerator. pattern Input pattern patternLength the length of input pattern. skeleton skeletonLength the length of input skeleton. options Options controlling whether the length of specified fields in the pattern are adjusted to match those in the skeleton (when this would not happen otherwise). For default behavior, use UDATPG_MATCH_NO_OPTIONS. dest pattern adjusted to match the skeleton fields widths and subtypes. destCapacity the capacity of dest. pErrorCode a pointer to the UErrorCode which must not indicate a failure before the function call.

Returns

the length of dest.

Stable:

ICU 4.4

An AppendItem format is a pattern used to append a field if there is no good match.

For example, suppose that the input skeleton is "GyyyyMMMd", and there is no matching pattern internally, but there is a pattern matching "yyyyMMMd", say "d-MM-yyyy". Then that pattern is used, plus the G. The way these two are conjoined is by using the AppendItemFormat for G (era). So if that value is, say "{0}, {1}" then the final resulting pattern is "d-MM-yyyy, G".

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.

This reflects the way that the CLDR data is organized.

Parameters

dtpg a pointer to UDateTimePatternGenerator. field UDateTimePatternField, such as UDATPG_ERA_FIELD value pattern, such as "{0}, {1}" length the length of value.

Stable:

ICU 3.8

Set the name of field, eg "era" in English for ERA.

These are only used if the corresponding AppendItemFormat is used, and if it contains a {2} variable.

This reflects the way that the CLDR data is organized.

Parameters

dtpg a pointer to UDateTimePatternGenerator. field UDateTimePatternField value name for the field. length the length of value.

Stable:

ICU 3.8

The DateTimeFormat is a message format pattern used to compose date and time patterns.

The default pattern in the root locale is "{1} {0}", where {1} will be replaced by the date pattern and {0} will be replaced by the time pattern; however, other locales may specify patterns such as "{1}, {0}" or "{1} 'at' {0}", etc.

This is used when the input skeleton contains both date and time fields, but there is not a close match among the added patterns. For example, suppose that this object was created by adding "dd-MMM" and "hh:mm", and its DateTimeFormat is the default "{1} {0}". 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".

There are four DateTimeFormats in a UDateTimePatternGenerator object, corresponding to date styles UDAT_FULL..UDAT_SHORT. This method sets all of them to the specified pattern. To set them individually, see udatpg_setDateTimeFormatForStyle.

Parameters

dtpg a pointer to UDateTimePatternGenerator. dtFormat message format pattern, here {1} will be replaced by the date pattern and {0} will be replaced by the time pattern. length the length of dtFormat.

Stable:

ICU 3.8

dateTimeFormats are message patterns used to compose combinations of date and time patterns.

There are four length styles, corresponding to the inferred style of the date pattern; these are UDateFormatStyle values:

• UDAT_FULL (for date pattern with weekday and long month), else
• UDAT_LONG (for a date pattern with long month), else
• UDAT_MEDIUM (for a date pattern with abbreviated month), else
• UDAT_SHORT (for any other date pattern). For details on dateTimeFormats, see https://www.unicode.org/reports/tr35/tr35-dates.html#dateTimeFormats. The default pattern in the root locale for all styles is "{1} {0}".

Parameters

udtpg a pointer to the UDateTimePatternGenerator style one of UDAT_FULL..UDAT_SHORT. Error if out of range. dateTimeFormat the new dateTimeFormat to set for the the specified style length the length of dateTimeFormat, or -1 if unknown and pattern is null-terminated pErrorCode a pointer to the UErrorCode (in/out parameter); if no failure status is already set, it will be set according to result of the function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range).

Stable:

ICU 71

The decimal value is used in formatting fractions of seconds.

If the skeleton contains fractional seconds, then this is used with the fractional seconds. 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"

Parameters

dtpg a pointer to UDateTimePatternGenerator. decimal length the length of decimal.

Stable:

ICU 3.8

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4