GetInternationalString method

Returns the internationalized string associated with a particular locale. The internationalized string for the locale passed in must have been added to the MxValue via calls to PutInternationalString, PutInternationalStringsVB, or PutInternationalStrings prior to calling this method.

Class

IMxValue

Syntax

[C#]

string GetInternationalString(

int locale

);

[Visual C++]

HRESULT GetInternationalString(

[in] long locale,

[out, retval] BSTR *internationalizedString

);

Parameters

locale,

The locale of the internationalized string that is to be retrieved from the MxValue.

internationalizedString

The internationalized string that corresponds to the locale passed in.

Returns

S_OK - operation succeeded.

E_FAIL - operation failed.

MX_E_WrongDataType - the stored value isn't an internationalized string.

MX_E_LocaleNotSupported - the internationalized text doesn't exist for the locale passed in.