Category Creo Parametric user interface, Object ProMessage

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: pfcSession::UIReadStringMessage
Synopsis
#include <ProMessage.h>
ProErrorProMessageStringRead(
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
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
  3. User Interface: Messages: Getting Keyboard Input

Sample Code References:

  1. pt_async ( TestAsync.c )
  2. pt_async ( TestAsync.c )
  3. pt_examples ( TestDrag.c )
  4. pt_examples ( TestDbms.c )
  5. pt_examples ( TestDimension.c )
  6. pt_examples ( TestFemmesh.c )
  7. pt_examples ( TestInterface.c )
  8. pt_examples ( TestInterface.c )
  9. pt_examples ( TestInterface.c )
  10. pt_examples ( TestInterface.c )
  11. pt_examples ( TestFamTab.c )
  12. pt_examples ( TestFamTab.c )
  13. pt_examples ( TestFamTab.c )
  14. pt_examples ( TestFeats.c )
  15. pt_examples ( TestGenedata.c )
  16. pt_examples ( TestGenedata.c )
  17. pt_examples ( TestGenedata.c )
  18. pt_examples ( TestGenedata.c )
  19. pt_examples ( TestXsec.c )
  20. pt_examples ( TestXsec.c )
  21. pt_examples ( TestDrwInfo.c )
  22. pt_examples ( TestDrwView.c )
  23. pt_examples ( TestDtlnote.c )
  24. pt_examples ( TestDtlsyminst.c )
  25. pt_examples ( TestGraphics.c )
  26. pt_examples ( TestLayer.c )
  27. pt_examples ( TestLayer.c )
  28. pt_examples ( TestLayer.c )
  29. pt_examples ( TestSymDefMenu.c )
  30. pt_examples ( TestView.c )
  31. pt_examples ( TestDrawing.c )
  32. pt_examples ( TestMessage.c )
  33. pt_examples ( TestCavityLayout.c )
  34. pt_examples ( TestCavityLayout.c )
  35. pt_examples ( TestTool.c )
  36. pt_examples ( TestRelation.c )
  37. pt_examples ( TestRelation.c )
  38. pt_examples ( TestRelation.c )
  39. pt_examples ( TestSetup.c )
  40. pt_examples ( TestSetup.c )
  41. pt_examples ( TestPartMaterial.c )
  42. pt_examples ( TestPartMaterial.c )
  43. pt_examples ( TestPartMaterial.c )
  44. pt_examples ( TestRule.c )
  45. pt_examples ( TestCollect.c )
  46. pt_examples ( TestCollect.c )
  47. pt_examples ( UtilMessage.c )
  48. pt_examples ( UtilMessage.c )
  49. pt_geardesign ( GearDesign.c )
  50. pt_geardesign ( GearDesign.c )
  51. pt_userguide ( UgAsmcompConstraint.c )
  52. pt_userguide ( UgDatumCreate.c )
  53. pt_userguide ( UgDrawingFromTmpltCreate.c )
  54. pt_userguide ( UgDtlgroupExamples.c )
  55. pt_userguide ( UgDtlsymdefExamples.c )
  56. pt_userguide ( UgDtlsymdefExamples.c )
  57. pt_userguide ( UgNoteCreate.c )
  58. pt_userguide ( UgExtAnalysisSurfcsys.c )
  59. pt_userguide ( UgXMLFeat.c )
  60. pt_userguide ( UgGeomSurfRename.c )
  61. pt_userguide ( UgPlotSetup.c )
  62. pt_userguide ( UgMenuConfirmGet.c )
  63. pt_userguide ( UgNavigatorPane.c )
  64. pt_userguide ( UgNavigatorPane.c )
  65. pt_userguide ( UgNavigatorPane.c )
  66. pt_userguide ( UgNavigatorPane.c )
  67. pt_userguide ( UgNavigatorPane.c )
  68. pt_userguide ( UgNavigatorPane.c )
  69. pt_userguide ( UgNavigatorPane.c )
  70. pt_userguide ( UgMessageWindowUse.c )
  71. pt_userguide ( UgModelLayerCreate.c )
  72. pt_userguide ( UgParamFeatLabel.c )
  73. pt_userguide ( UgParamFeatLabel.c )
  74. pt_userguide ( UgSolidNoteCreate.c )
  75. pt_userguide ( UgUtilFile.c )
  76. pt_userguide ( UgUtilFile.c )