InputFromScreen

Syntax

  #include <screen.h> 
   
  int InputFromScreen (
     scr_t         scrID,
     const char   *allowedCharacterSet,
     size_t        bufferLength,
     size_t        editWidth,
     char         *buffer,
     int           linesToProtect,
     int           hasDefaultString,
     const char   *defaultString,
     const char   *promptText,
     ... )”;
  

Parameters

scrID

(IN) Specifies the screen ID where the message is to be displayed.

allowedCharacterSet

(IN) Points to a string defining the allowable characters; use "../xFF" for the ASCII character set.

bufferLength

(IN) Specifies the size, in bytes, of the buffer.

editWidth

(IN) Specifies the number of bytes in the input string.

buffer

(OUT) Points to the buffer that receives the input string from the screen.

linesToProtect

(IN) Specifies the number of lines that have to be protected from the current input row upwards. Thus, if linesToProtect is 2 and the current input row number is 4, rows 3 and 4 have to protected.

hasDefaultString

(IN) Specifies whether a default string exists for the screen.

• TRUE — A default string exists.
• FALSE — A default string does not exist.

defaultString

(IN) Points to the null terminated string, which is the default string. Pass NULL if one does not exist.

promptText

(IN) Points to a null-terminated string, which prompts the user for input. This string is an ASCII control string similar to that used with the sprintf function (except for floating point specifiers). See Print Format Control Strings.

...

Specifies arguments indicated by the promptText parameter.

Return Values

If successful, returns 0.

Remarks

For sample code, see Scroll.c.

See Also

• OutputToScreen