Category Creo Parametric user interface, Object ProMessage

Function ProMessagePasswordRead


Description
Reads user input in the form of character strings. The input is not visible in the message area. 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: pfcSession::UIReadStringMessage
Synopsis
#include <ProMessage.h>
ProErrorProMessagePasswordRead(
int max_password_length
/* (In)
The maximum length (up to 127 characters) of the string put into password
*/
wchar_t* password
/* (Out)
The user's input
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully read a string.
PRO_TK_MSG_USER_QUITThe user canceled input by typing <ESC>.
PRO_TK_GENERAL_ERRORThe function failed to read a string. This includes the case of the user entering <CR> without typing any characters.)

Manual References:

  1. Pro/DEVELOP to Creo Toolkit Function Mapping: Equivalent Pro/DEVELOP Functions
  2. User Interface: Messages: Getting Keyboard Input

Sample Code References:

  1. pt_examples ( TestMessage.c )