IntlLocal(3tlib)

IntlLocal, IntlLocalizeMsg -- localize message

Synopsis

IntlLocalizeMsg messageId [argList]
IntlLocal type messageId [argList]

Description

These functions provide the support for fully internationalizing Tcl applications using symbolic message ids and external message catalogs. Both return properly localized data.

IntlLocal: localize the specified message and optionally format arguments into the message as with sprintf. This is equivalent to a IntlLocal command with the text option. With the ``type'' argument, IntlLocal can return a Tcl list structure rather than just the localized text.
IntlLocalizeMsg: localize the specified message and optionally format arguments into the message as with sprintf(3S).

Arguments

messageId: the symbolic message ID. It must be in the form XXXX_MSG_YYYY or XXXX_ERR_YYYY. It is used to index the external message catalog or the default message set defined locally in the application itself.
argList: a list of arguments to format into the message. There must be corresponding sprintf format specifications in the message catalog string. Use of the %n$ form is encouraged fot multiple format specifiers.
type: the type of localized message format returned: "text" - Return the message as a localized text string only "ext" - Return the message in the external, Tcl list format:

{msgId moduleIdNum msgNum msgText}

References

gencat(1), mkcatdecl(1).

Notices

If the Tcl message declaration file for the module ID has not been sourced, it will be loaded from the a Tcl library.