IlsTranslationMng Class Reference

API FOR ADVANCED USERS – This class is used to managed the encoding and decoding functions used to translate strings between different locales. More...

#include <ilserver/ilthread.h>

Public Types
typedef IlsBoolean(*	FailCb) (const IlsString &curSysLocale, const IlsString &remSysLocale)
	Callback type for IlsTranslationMng::SetFailCb(). More...

Static Public Member Functions
static IlsBoolean	DeclareTranslation (const IlsString &name, IlsMsgEncoder encode, IlsMsgDecoder decode, int=-1)
	Associates the identifier name with the encoding function encode and the decoding function decode. More...
static FailCb	GetFailCb ()
	Returns the callback peviously declared by the static member function SetFailCb(), or 0 by default.
static void	SetFailCb (FailCb)
	Declares a callback that is called by Rogue Wave Server if no encoding/decoding functions can be found when a component connects to a server. More...
static IlsBoolean	UndeclareTranslation (const IlsString &name)
	Dissociates the identifier name from an encoding function and a decoding function. More...

Detailed Description

API FOR ADVANCED USERS – This class is used to managed the encoding and decoding functions used to translate strings between different locales.

Library: server
and mvcomp

See the internationalisation guide for more informations about translation between different locale encodings.

See also

IlsString.

Member Typedef Documentation

FailCb

typedef IlsBoolean(* IlsTranslationMng::FailCb) (const IlsString &curSysLocale, const IlsString &remSysLocale)

Callback type for IlsTranslationMng::SetFailCb().

• If this callback returns IlsTrue, the connection is accepted, but no translation is done.
• If it returns IlsFalse, the connection is closed.

Member Function Documentation

DeclareTranslation()

static IlsBoolean IlsTranslationMng::DeclareTranslation ( const IlsString &  name, IlsMsgEncoder  encode, IlsMsgDecoder  decode, int  = -1  )

static

Associates the identifier name with the encoding function encode and the decoding function decode.

This function returns IlsTrue if no such association with the same name has been previously registered. Otherwise, it returns IlsFalse.

SetFailCb()

static void IlsTranslationMng::SetFailCb ( FailCb  )

static

Declares a callback that is called by Rogue Wave Server if no encoding/decoding functions can be found when a component connects to a server.

• If this callback returns IlsTrue, the connection is accepted, but no translation is done.
• If it returns IlsFalse, the connection is closed.

UndeclareTranslation()

static IlsBoolean IlsTranslationMng::UndeclareTranslation ( const IlsString &  name )

static

Dissociates the identifier name from an encoding function and a decoding function.

It returns IlsTrue if such an association has been previously registered. Otherwise, it returns IlsFalse.