Function ProMessageStringRead
Description
Reads a line of keyboard input and returns the contents as a wide string. Specify default values in the call to ProMessageDisplay(), using the separator ||| in the format string in the message file. (See the Creo Parametric TOOLKIT User's Guide section Contents of the Message File for the specific placement of the ||| separator.)
NOTE:Call ProMessageDisplay before calling this function.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProMessage.h>
ProMessageStringRead | |
( int max_buffer_length /* (In) The maximum length (up to 127 characters) of the string put into buffer */ wchar_t* buffer /* (Out) The user's input */ ) |
Returns
The function successfully read a string. | |
The user canceled input by typing <ESC>. | |
The function failed to read a string. This includes the case of the user entering <CR> without typing any characters. |
Sample Code References
User Guide References