IMessageSource Class Reference

Interface used to load OEM and localized messages. More...

Inherits Simba::Support::ThreadSafeSharedObject.

Inherited by DSIMessageSource.

List of all members.

Public Member Functions

virtual simba_int32 GetNativeErrorCode (const simba_wstring &in_messageID, simba_int32 in_sourceComponentID)=0
 Returns the native error code for the given message.
virtual void LoadMessage (const simba_string &in_locale, const simba_wstring &in_messageID, simba_int32 in_sourceComponentID, const std::vector< simba_wstring > &in_messageParams, simba_wstring &out_message, simba_int32 &out_nativeErrCode)=0
 Retrieves the specified message with its associated error code.
virtual void LoadMessage (const simba_string &in_locale, const simba_wstring &in_messageID, simba_int32 in_sourceComponentID, const std::vector< simba_wstring > &in_messageParams, simba_wstring &out_message)=0
 Retrieves the specified message with its associated error code.
virtual void LoadMessage (const simba_string &in_locale, const simba_wstring &in_messageID, simba_int32 in_sourceComponentID, simba_wstring &out_message, simba_int32 &out_nativeErrCode)=0
 Retrieves the specified message with its associated error code.
virtual void LoadMessage (const simba_string &in_locale, const simba_wstring &in_messageID, simba_int32 in_sourceComponentID, simba_wstring &out_message)=0
 Retrieves the specified message with its associated error code.
virtual ~IMessageSource ()
 Destructor.

Protected Member Functions

 IMessageSource ()
 Constructor.

Detailed Description

Interface used to load OEM and localized messages.


Constructor & Destructor Documentation

virtual ~IMessageSource (  )  [inline, virtual]

Destructor.

IMessageSource (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual simba_int32 GetNativeErrorCode ( const simba_wstring in_messageID,
simba_int32  in_sourceComponentID 
) [pure virtual]

Returns the native error code for the given message.

Parameters:
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
Returns:
The native error code for the given message, DSI_INVALID_ERRORCODE if the message was not found.
virtual void LoadMessage ( const simba_string in_locale,
const simba_wstring in_messageID,
simba_int32  in_sourceComponentID,
const std::vector< simba_wstring > &  in_messageParams,
simba_wstring out_message,
simba_int32 out_nativeErrCode 
) [pure virtual]

Retrieves the specified message with its associated error code.

Parameters:
in_locale The locale.
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
in_messageParams Parameters used to fill in the message.
out_message The message for the given message and component ID.
out_nativeErrCode The error code for the given message and component ID.
virtual void LoadMessage ( const simba_string in_locale,
const simba_wstring in_messageID,
simba_int32  in_sourceComponentID,
const std::vector< simba_wstring > &  in_messageParams,
simba_wstring out_message 
) [pure virtual]

Retrieves the specified message with its associated error code.

Parameters:
in_locale The locale.
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
in_messageParams Parameters used to fill in the message.
out_message The message for the given message and component ID.
virtual void LoadMessage ( const simba_string in_locale,
const simba_wstring in_messageID,
simba_int32  in_sourceComponentID,
simba_wstring out_message,
simba_int32 out_nativeErrCode 
) [pure virtual]

Retrieves the specified message with its associated error code.

Parameters:
in_locale The locale.
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
out_message The message for the given message and component ID.
out_nativeErrCode The error code for the given message and component ID.
virtual void LoadMessage ( const simba_string in_locale,
const simba_wstring in_messageID,
simba_int32  in_sourceComponentID,
simba_wstring out_message 
) [pure virtual]

Retrieves the specified message with its associated error code.

Parameters:
in_locale The locale.
in_messageID Unique message identifier.
in_sourceComponentID Source component identifier.
out_message The message for the given message and component ID.

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba