IlsTranslationMng

Category

Dynamic views (Server and component) - API FOR ADVANCED USERS

Inheritance Path

IlsTranslationMng

Description

This class is used to managed the encoding and decoding functions used to translate strings between different locales. See the internationalisation guide for more informations about translation between different locale encodings.

Library

Header File

#include <ilserver/ilthread.h>

Synopsis

class IlsTranslationMng

{

public:

typedef IlsBoolean (*FailCb)(const char* curSysLocale,

const char* remSysLocale);

static IlsBoolean DeclareTranslation(const char*,

IlsMsgEncoder,

IlsMsgDecoder, int = -1);

static IlsBoolean UndeclareTranslation(const char*);

static void SetFailCb(FailCb);

static FailCb GetFailCb();

};

Member Functions

[static] IlsBoolean DeclareTranslation(const char* name,

IlsMsgEncoder encode,

IlsMsgDecoder decode);

This static member function 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.

[static] IlsBoolean UndeclareTranslation(const char*);

This static member function 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.

[static] void SetFailCb(FailCb);

This static member function 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.

[static] FailCb GetFailCb();

This static member function returns the callback peviously declared by the static member function SetFailCb documented above, or 0 by default.