pad_inq_kbd() — Apollo

PAD_$INQ_KBD                      Domain/OS                       PAD_$INQ_KBD


NAME
     pad_$inq_kbd - find out about the keyboard

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/pad.h>

     void pad_$inq_kbd(
          ios_$id_t &stream_id,
          short &buffer_size,
          char *kbd_suffix,
          short *length,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/pad.ins.pas';

     procedure pad_$inq_kbd(
          in stream_id: ios_$id_t;
          in buffer_size: integer;
          out kbd_suffix: univ pad_$string_t;
          out length: integer;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/pad.ins.ftn'

           integer*4 status
           integer*2 stream_id, buffer_size, length
           character kbd_suffix*256

           call pad_$inq_kbd(stream_id, buffer_size, kbd_suffix,
          &                  length, status)

DESCRIPTION
     Pad_$inq_kbd reports the type of keyboard providing input on the speci-
     fied stream ID.  The keyboard type is returned as an ASCII string used as
     a pathname suffix for key definition files accessed by the Display
     Manager.  This call is useful for tailoring programmable function key
     definitions to the type of keyboard in use.

     stream_id
          A stream ID for an input or transcript pad.  Pad_$inq_kbd returns
          the type of keyboard providing the input on stream_id.

     buffer_size
          The number of bytes available to hold the returned kbd_suffix.

     kbd_suffix
          The suffix for a key definition file.  The suffixes used by standard
          Domain/OS software are

          "" (a null string)
               The 880 keyboard.

          "2"  The low-profile keyboard.

          "3"  The low-profile keyboard with a numeric keypad.

     length
          The number of bytes in kbd_suffix.  If length is greater than
          buffer_size, the string loaded in kbd_suffix is truncated.

     status
          The completion status.

SEE ALSO
     pad_$inq_disp_type.
Museum
