U@GETLOCCLPHRX

U@GETLOCCLPHRX allows a developer using a specified locale to retrieve a translated phrase in columns. Use this API when the translation has columns whose width requires the text to be split into multiple rows. To retrieve phrases in columns when using the locale set in the user's profile, use U@GETCOLPHRXLT.

Module DATABASE

Required Fields

Field Type and length Definition
E@COLPHRROWCNT N 4 Indicates the maximum number of rows in the translation.
E@COLPHRCOLWDT N 4 Maximum number of characters in a row.
E@COLPHRROW A 50 One row of the English phrase used to retrieve the translated phrase. Occurs up to 5 times. Number of characters in all occurrences can not exceed 50.
E@COLPHRXLTROW A 50

One row of the translated phrase. Occurs up to 5 times. Number of characters in all occurrences can not exceed 50.

If the routine cannot find the locale, the locale's language, or the translated phrase, or it finds incorrect values for rows or width, the English phrase is passed back in the E@COLPHRXLT field instead of a translated phrase. The API never returns an error; it either retrieves the translation, or passes back the English phrase.
E@LOCALE A 10 Locale used to retrieve the translated phrase.

Programming Example

This example retrieves a phrase.

    EVAL      E@COLPHRROWCNT = 3
    EVAL      E@COLPHRCOLWDT = 8
    EVAL      E@COLPHRROW(1) = first-row 
    EVAL      E@COLPHRROW(2) = second-row 
    EVAL      E@COLPHRROW(3) = third-row 
    EVAL      E@LOCALE       = locale-name
    CALLP     U@GETLOCCLPHRX