Function ProMessageToBuffer

Documentación de la API > Creo Parametric user interface > Object ProMessage > Function ProMessageToBuffer

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 string 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.

Replacement in Object TOOLKIT:

pfcBaseSession::GetMessageContents

Synopsis

#include <ProMessage.h>

ProError	ProMessageToBuffer
	( ProLine translated_msg /* (Out) The formatted and translated message / 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_ERROR	The function successfully printed the message.
PRO_TK_E_NOT_FOUND	The specified message file was not found.
PRO_TK_CANT_OPEN	The system could not read the message file.
PRO_TK_MSG_NOT_FOUND	The specified message was not found in the message file.
PRO_TK_MSG_NO_TRANS	The message text (in the current language of the user interface) was not found.
PRO_TK_MSG_FMT_ERROR	There was a format error in the message text.
PRO_TK_MSG_TOO_LONG	The message was longer than (PRO_LINE_SIZE - 1) characters and has been truncated to fit.
PRO_TK_E_FOUND	The specified message was not found in memory and the message file was read previously. This may indicate that there are two different message files with the same name; avoid this problem by including the application name in the file name.
PRO_TK_GENERAL_ERROR	The message was not printed.