Difference between revisions of "Translations:Documents/API/27/en"

'''Public methods:'''
* ''void load( );'' — Download. 
* ''void save( );'' — Saving. 
* ''string codeConv( const string &fromCH, const string &toCH, const string &mess);'' — Conversion of the codepage of the messages. 
* ''string codeConvIn( const string &fromCH, const string &mess);'' — Conversion the codepage of the messages into the internal system codepage. 
* ''string codeConvOut ( const string &toCH, const string &mess);'' — Conversion of the message from the internal system codepage.
* ''string I18N( const string &mess, const char *mLang = NULL, const char *d_name = NULL );'' — Getting the message ''mess'' in the language ''mLang'' for the system translation from the directory ''d_name'', NULL for the OpenSCADA core.
* ''string lang( );'' — Language of the system, as en_US.UTF-8. 
* ''string langCode( const string &user = "", bool onlyUser = false );'' — Language code of the system. Specify ''user'' for obtaining its language and ''onlyUser'' for only that.
* ''string &charset( );'' — The system codepage. 
* ''int logDirect( );'' — Receivers to whom the system messages (stdout, stderr, syslog, archive) are sent.
* ''int messLevel( );'' — The level below which the messages are ignored.
* ''static bool messLevelTest( int8_t condLev, int8_t messLev );'' — The message level testing for ''messLev'' >= ''condLev'' counting the message sub-levels — the second digit, where ''condLev'' is ±[0...7] and ''messLev'' is ±[0...79].
* ''string selDebCats( );'' — Selected debug categories (by separated ';' list).
* ''bool isUTF8( );'' — Internal codepage is UTF-8.
* ''void setLang( const string &lang );'' — Setting of the system language (localization).
* ''void setLogDirect( int dir );'' — Setting receivers to which the system messages are sent. For ''dir'' the bit mask is used. Where: 
:1 — to syslog;
:2 — to stdout;
:4 — to stderr;
:8 — to the archive.
* ''void setMessLevel( int level );'' — Setting a minimum level of processed messages. 
* ''void setSelDebCats( const string &vl );'' — Debug categories set (by separated ';' list).
* ''void put( const char *categ, int8_t level, const char *fmt,  ... );'' — The message forming for the current time with the category ''categ'', the ''level'', the formatted message ''fmt'' and the followed arguments.
* ''void put_( const char *categ, int8_t level, const char *fmt, ... ); void putArg( const char *categ, int8_t level, const char *fmt, va_list ap );'' — The message forming for the current time (selected level and debug categories are ignored) with the category ''categ'', the ''level'', the formatted message ''fmt'' and the followed arguments.
* ''void get( time_t b_tm, time_t e_tm, vector<TMess::SRec> &recs, const string &category = "", int8_t level = Debug );'' — Get the message from the archive for the period of time ''b_tm'' — ''e_tm'' under the category template ''category'' and minimum level ''level''. 
* ''string langCodeBase( );'' — The language of basic variables of the text messages.
* ''string langBase( );'' — The language-locale of basic variables and the locales list used in the project translation, separated by ';'.
* ''string langToLocale( const string &lang );'' — Getting the complete locale from ''langBase()'' at the language ''lang''.
* ''bool translCfg( );'' — The configuration translation sign, combined as "'''langCodeBase().size() && langCode() != langCodeBase()'''".
* ''bool translDyn( bool plan = false );'' — Mode "Dynamic translation" or the ''plan'' to next start.
* ''bool translEnMan( );'' — The sign "Enabled translations manager", for activation of the built translation messages index and the translation manager.
* ''string translLangs( );'' — List of translation languages, into the manager.
* ''string translFld( const string &lng, const string &fld, bool isCfg = false );'' — Representing the translated field name by the field name ''fld'' and language ''lng'' for configuration ''isCfg'' or DB.
* ''bool isMessTranslable( const string &vl );'' — Checking the message ''vl'' for availability of it translation, has no only space, digit and punctuation symbols.
* ''void setLangBase( const string &vl );'' — Setting the language-locale of basic variables and the locales list used in the project translation.
* ''void setTranslDyn( bool val, bool plan = true );'' — Setting the mode "Dynamic translation" or the ''plan'' to value ''val'' for next start.
* ''void setTranslEnMan( bool vl, bool passive = false );'' — Setting "Enabled translation manager" to value ''vl'' and passive mode ''passive''.
* ''void setTranslLangs( const string &vl );'' — Setting a list of translation languages.
* ''string translGet( const string &base );'' — Getting translation for ''base'' text variable using the translation context.
* ''string translGet( const string &base, const string &lang, const string &src = "" ); string translGetU( const string &base, const string &user, const string &src = "" ); string translGetLU( const string &base, const string &lang, const string &user, const string &src = "" );'' — Getting translation for ''base'' text variable for language ''lang'' or ''user'' and optional source ''src''.
* ''string translSet( const string &base, const string &mess );'' — Setting translation for ''base'' text variable to value ''mess'' using the translation context.
* ''string translSet( const string &base, const string &lang, const string &mess, bool *needReload = NULL ); string translSetU( const string &base, const string &user, const string &mess, bool *needReload = NULL ); string translSetLU( const string &base, const string &lang, const string &user, const string &mess, bool *needReload = NULL );'' — Setting translation for ''base'' text variable for language ''lang'' or ''user'' and optional source ''src'' to value ''mess''.
* ''void translReg( const string &mess, const string &src, const string &prms = "" );'' — Registering the translated message ''mess'' with source ''src'' and appended parameters ''prms'' into the translations index.
* ''string translCacheGet( const string &key, bool *ok = NULL );'' — Getting the translation message at the ''key'' in the form "{lang}#{base}[\000{cat}]" from the translation cache. Where ''cat' can be: EMPTY — for dynamic messages, "sys" — for system messages and "user" — for the users used in the dynamic language obtaining. You can pass ''ok'' for detection the message really placing in the cache.
* ''void translCacheSet( const string &key, const string &val );'' — Setting the translation message ''val'' at the ''key'' to the translation cache.
* ''void translCacheLimits( time_t tmLim = 0, const char *clrCat = NULL );'' — Processing the translation cache limits at the size ''trMessCache'' and the nonzero time ''tmLim''. Also that can clear the messages in the category ''clrCat''.
* ''void translIdxCacheUpd( const string &base, const string &lang, const string &mess, const string &src );'' — Updating the operative translation messages' index and cache in the MULTILANGUAGE-DYNAMIC mode.
* ''bool translItSplit( const string &base, const string &srcFltr = "" );'' — Splitting the BASE message ''base'' per it sources and only for matched ones to ''srcFltr''.
* ''bool translItRemTrs( const string &base, const string &srcFltr = "" );'' — Removing the BASE message ''base'' from the individual messages table "Trs" and only for matched sources to ''srcFltr''.
* ''string trCtx( const string &user_lang = mess_TrModifMark, bool *hold = NULL );'' — Getting (by default) and registering(no empty)/clearing(empty) the translation context ''user_lang'' bound to the call pthread. ''hold'' can be pointed to detect the context already registered and do not clear that.
* ''static string labStorFromCode( const string &code ); static string labStor( ); static string labStorRem( const string &cnt ); static string labSecCRON( ); static string labSecCRONsel( ); static string labTaskPrior( ); static string labStdOutTrs( ); static string labMessCat( ); static string labTime( ); static string labTimeSel( );'' — Common help labels.
* ''int getUTF8( const string &str, int off = 0, uint32_t *symb = NULL );'' — Get and parse a UTF-8 symbol.
* ''static string setUTF8( uint32_t symb );'' — Set, form and return a UTF-8 symbol from their code ''symb''.