Category Creo Parametric user interface, Object ProMessage

Function ProMessageWstringbufferAlloc


Description
Places the translated contents of a formatted message into the specified output buffer. This function works just like ProMessageDisplay(), except the message is written to a wstring instead of the message area.

This function takes 0 to 10 additional arguments to be substituted for conversion specifiers in the text of the message, similar to printf().

NOTE:

This is an exception to the Creo Parametric TOOLKIT standard of putting output arguments after input arguments, due to the variable number of input arguments.

Synopsis
#include <ProMessage.h>
ProErrorProMessageWstringbufferAlloc(
wchar_t** translated_msg
/* (Out)
The formatted and translated message, Free this string using ProWstringFree().
*/
ProFileName file_name
/* (In)
The name of the file that contains the message
*/
ProCharLine message_name
/* (In)
The name of the message in the file
*/
...
/* (In)
0 through 9 values of input variants.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully printed the message.
PRO_TK_MSG_NOT_FOUNDThe specified message was not found in the message file.
PRO_TK_MSG_FMT_ERRORThere was a format error in the message text.
PRO_TK_BAD_INPUTSOutput parameter is NULL.

Manual References:

  1. User Interface: Messages: Writing a Message to an Internal Buffer