en:ibm:prcp:kbd:strin

Differences

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

Link to this comparison view

Next revision		Previous revision
en:ibm:prcp:kbd:strin [2014/05/16 18:52] – created 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 79: Line 41:
 **Remarks** **Remarks**
  
-The character strings may be optionally echoed on the display if echo mode is set. When echo is on each character is echoed as it is read from the keyboard. Echo mode and BINARY mode are mutually exclusive. Reference KbdSetStatus and KbdGetStatus for more information. +The character strings may be optionally echoed on the display if echo mode is set. When echo is on each character is echoed as it is read from the keyboard. Echo mode and BINARY mode are mutually exclusive. Reference //[[setstatus|KbdSetStatus]]// and //[[getstatus|KbdGetStatus]]// for more information. 
  
 The default input mode is ASCII. In ASCII mode, 2-byte character codes only return in complete form. An extended ASCII code is returned in a 2-byte string. The first byte is 0DH or E0H and the next byte is an extended code.  The default input mode is ASCII. In ASCII mode, 2-byte character codes only return in complete form. An extended ASCII code is returned in a 2-byte string. The first byte is 0DH or E0H and the next byte is an extended code. 
  
-In input mode (BINARY, ASCII), The following returns can be set and retrieved with KbdSetStatus and KbdGetStatus: +In input mode (BINARY, ASCII), The following returns can be set and retrieved with //[[setstatus|KbdSetStatus]]// and //[[getstatus|KbdGetStatus]]//: 
  
 Turnaround Character  Turnaround Character 
Line 90: Line 52:
 Shift State  Shift State 
  
-The received input length is also used by the KbdStringIn line edit functions for re-displaying and entering a caller specified string. On the next KbdStringIn call the received input length indicates the length of the input buffer that may be recalled by the user using the line editing keys. A value of 0 inhibits the line editing function for the current KbdStringIn request. +The received input length is also used by the //KbdStringIn// line edit functions for re-displaying and entering a caller specified string. On the next //KbdStringIn// call the received input length indicates the length of the input buffer that may be recalled by the user using the line editing keys. A value of 0 inhibits the line editing function for the current //KbdStringIn// request. 
  
-KbdStringIn completes when the handle has access to the physical keyboard (focus), or is equal to zero and no other handle has the focus. +//KbdStringIn// completes when the handle has access to the physical keyboard (focus), or is equal to zero and no other handle has the focus. 
  
 +**Family API Considerations**
  
-Family API Considerations +Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restrictions apply to //KbdStringIn// when coding in the DOS mode: 
  
-Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restrictions apply to KbdStringIn when coding in the DOS mode: +  * //KbdHandle// is ignored 
  
-oKbdHandle is ignored +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>
  
-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.