::XllTranslateString

Translates a string containing resource IDs, for the language of the Excel version

[C++]
BOOL XllTranslateString(
   const char* pszIn,
   CString& strOut
);

Parameters

pszIn: input string, which may contain numeric resource string identifiers. See Remarks below.
strOut: If the function succeeds, the translated string will be loaded into this variable. If it fails, then an untranslated or partially translated string will be placed here.

Return value

TRUE if the function succeeds, FALSE if it fails. It will fail if any the resources cannot be found or if the current resource file handle is invalid. If it fails, then a partially or wholly untranslated string will be returned.

Remarks

This function attempts to replace the resource string IDs in the input string with resource strings loaded from the current resource file. The resource file searched will be that returned by XllGetStringResourceHandle). The language used will be either the current user preference (as returned by GetThreadLocale()) or the language of the Excel version (as returned by XllGetExcelLanguageID).

String identifiers should be in one of the following forms:

Integers preceded by a # sign, e.g.: #123, which will be replaced by strings in the user's language.
Integers preceded by "#@", e.g.: #@123, which will be replaced by strings in the language of the Excel version that is running.

See String substitutions for more information.

String substitution by XLL+ functions

The functions, macros and data members that accept and translate resource ID strings are listed below.

IMPLEMENT_XLLFN2	IMPLEMENT_XLLFN_EX	CXllApp::m_stName
CXllApp::WinMessageBox	CXllApp::XlMessageBox	CXllFn::m_stCategory
CXllFn::m_stHelpText	CXllFn::m_astArgHelpText	CXllFn::m_astArgExt
CXlMenu::Create	CXlMenu::AddItem	CXlMenu::SetTexts
CXlMenu::DeleteItem	CXlMenu::ReplaceItem	CXlMenu::EnableItem
CXlMenu::CheckItem	CXlToolbar::AddSeparator	CXlToolbar::AddTool
CXlToolbar::AddToolbar	CXlToolbar::AssignToTool	CXlToolbar::DeleteTool
CXlToolbar::DeleteToolbar	CXlToolbar::EnableTool	CXlToolbar::PressTool
CXlToolbar::SetToolBitmap	CXlToolbar::ShowToolbar

Requirements