en:ibm:prcp:kbd:strin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:ibm:prcp:kbd:strin [2014/05/16 19:19] – valeriusen:ibm:prcp:kbd:strin [2016/09/15 03:00] (current) – valerius
Line 1: Line 1:
 ==== KndStringIn ==== ==== KndStringIn ====
  
-**Bindings**: +**Bindings**: [[strin#C bindings|C]], [[strin#MASM bindings|MASM]]
- +
-**C**: +
-<code c> +
-typedef struct _STRINGINBUF {   /* kbsi */ +
-  USHORT cb;                    /* input buffer length */ +
-  USHORT cchIn;                 /* received input length */ +
-} STRINGINBUF; +
- +
-#define INCL_KBD +
- +
-USHORT  rc = KbdStringIn(CharBuffer, Length, IOWait, KbdHandle); +
- +
-PCH              CharBuffer;    /* Char string buffer */ +
-PSTRINGINBUF     Length;        /* Length table */ +
-USHORT           IOWait;        /* Indicate if wait for char */ +
-HKBD             KbdHandle;     /* Keyboard handle */ +
- +
-USHORT           rc;            /* return code */ +
-</code> +
- +
-**MASM**: +
-<code asm> +
-STRINGINBUF struc +
-  kbsi_cb    dw  ? ;input buffer length +
-  kbsi_cchIn dw  ? ;received input length +
-STRINGINBUF ends +
- +
-EXTRN  KbdStringIn:FAR +
-INCL_KBD            EQU 1 +
- +
-PUSH@  OTHER   CharBuffer    ;Char string buffer +
-PUSH@  OTHER   Length        ;Length table +
-PUSH   WORD    IOWait        ;Indicate if wait for char +
-PUSH   WORD    KbdHandle     ;Keyboard handle +
-CALL   KbdStringIn +
- +
-Returns WORD +
-</code>+
  
 This call reads a character string (character codes only) from the keyboard.  This call reads a character string (character codes only) from the keyboard. 
Line 61: Line 23:
  
 ^Value ^Definition ^ ^Value ^Definition ^
-|0 |Wait. In Binary input mode, the requestor waits until CharBuffer is full. In ASCII input mode, the requestor waits until a carriage return is pressed. | +|0 |Wait. In Binary input mode, the requestor waits until //CharBuffer// is full. In ASCII input mode, the requestor waits until a carriage return is pressed. | 
-|1 |No wait. The requestor gets an immediate return if no characters are available. If characters are available, KbdStringIn returns immediately with as many characters as are available (up to the maximum). No wait is not supported in ASCII input mode. |+|1 |No wait. The requestor gets an immediate return if no characters are available. If characters are available, //KbdStringIn// returns immediately with as many characters as are available (up to the maximum). No wait is not supported in ASCII input mode. |
  
 //KbdHandle// (**HKBD**) - input  //KbdHandle// (**HKBD**) - input 
Line 101: Line 63:
  
 Refer to the //DosRead// Family API Considerations for differences between DOS and OS/2 node when reading from a handle opened to the CON device.  Refer to the //DosRead// Family API Considerations for differences between DOS and OS/2 node when reading from a handle opened to the CON device. 
 +
 +=== C bindings ===
 +
 +<code c>
 +typedef struct _STRINGINBUF {   /* kbsi */
 +  USHORT cb;                    /* input buffer length */
 +  USHORT cchIn;                 /* received input length */
 +} STRINGINBUF;
 +
 +#define INCL_KBD
 +
 +USHORT  rc = KbdStringIn(CharBuffer, Length, IOWait, KbdHandle);
 +
 +PCH              CharBuffer;    /* Char string buffer */
 +PSTRINGINBUF     Length;        /* Length table */
 +USHORT           IOWait;        /* Indicate if wait for char */
 +HKBD             KbdHandle;     /* Keyboard handle */
 +
 +USHORT           rc;            /* return code */
 +</code>
 +
 +=== MASM bindings ===
 +
 +<code asm>
 +STRINGINBUF struc
 +  kbsi_cb    dw  ? ;input buffer length
 +  kbsi_cchIn dw  ? ;received input length
 +STRINGINBUF ends
 +
 +EXTRN  KbdStringIn:FAR
 +INCL_KBD            EQU 1
 +
 +PUSH@  OTHER   CharBuffer    ;Char string buffer
 +PUSH@  OTHER   Length        ;Length table
 +PUSH   WORD    IOWait        ;Indicate if wait for char
 +PUSH   WORD    KbdHandle     ;Keyboard handle
 +CALL   KbdStringIn
 +
 +Returns WORD
 +</code>