ippGetMessageStatusI18n

Returns the translation of the status message.

Syntax

IppStatus ippGetMessageStatusI18n(const IppMsgCatalog* pMsgCatalog, IppStatus stsCode, IppMsg* pMsg);

Parameters

pMsgCatalog	Pointer to the message catalog.
stsCode	Code of an Intel IPP status.
pMsg	Pointer to the string containing the translated status message.

Description

The function ippGetMessageStatusI18n is declared in the ippcore.h file. This function returns the string pMsg containing the translation of the status message corresponding to stsCode. The translated message is encoded in UTF16 on Windows* OS, and UTF8 on Linux* OS. The messages are stored in the message catalog pMsgCatalog. On Linux* OS the binary message catalog is generated using the gencat utility (for more details see X/OPen Message Catalog Handling [OMC ]). On Windows* OS the binary message catalog is generated using the message compiler (mc) and resource compiler (rc) utilities of the Microsoft SDK Tools.

The message catalog pMsgCatalog must be opened by the function ippMessageCatalogOpenI18n beforehand. The returned pMsg is freed by the function ippMessageCatalogCloseI18n.

If the translation is not available, the function returns the not translated status message.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error condition when one of the specifiied pointer is NULL.
ippStsMemAllocErr	Indicates an error condition when no memory allocated.
ippStsContextMatchErr	Indicates an error condition when the catalog identifier is not correct.
ippStsUnknownStatusCodeErr	Indicates an error condition when stsCode has unknown value.
ippStsI18nMsgCatalogInvalid	Indicates a warning when the message catalog is not valid; the status message in English is returned.
ippStsI18nGetMessageFail	Indicates a warning when the function cannot return the translated message; the status message in English is returned. To get extended information use errno on Linux* OS and GetLastError on Windows* OS.