@DATABASE "ConsoleDeviceE"
@MASTER   "Work2:AD/Idoc/ConsoleDeviceE.doc"
@REMARK   This file was created by ADtoHT 2.0 on 28-Apr-97  12:57:56
@REMARK   Do not edit
@REMARK   ADtoHT is © 1993-1995 Christian Stieber

@NODE MAIN "ConsoleDeviceE.doc"
@TOC "__pOS_Dev.guide/MAIN"

                               @{b}console.device@{ub}

@{"CMDCD_AskDefaultKeyMap()" LINK "CMDCD_AskDefaultKeyMap"}  @{"CMDCD_AskKeyMap()" LINK "CMDCD_AskKeyMap"}  @{"CMDCD_InitStruct()" LINK "CMDCD_InitStruct"}
@{"CMDCD_SetDefaultKeyMap()" LINK "CMDCD_SetDefaultKeyMap"}  @{"CMDCD_SetKeyMap()" LINK "CMDCD_SetKeyMap"}  @{"CMDCD_Slide()" LINK "CMDCD_Slide"}
@{"ConsoleDeviceGeneral()" LINK "ConsoleDeviceGeneral"}    @{"pOS_MapRawKey()" LINK "pOS_MapRawKey"}    @{"pOS_RawKeyConvert()" LINK "pOS_RawKeyConvert"}

@ENDNODE
@NODE "ConsoleDeviceGeneral" "console.device/ConsoleDeviceGeneral()"
@{b}

  STRUCTURES@{ub}

        @{"struct pOS_Device" LINK "pExec/Device.h/File" 21}
        @{"struct pOS_InputEvent" LINK "Device/IEvent.h/File" 232}
        @{"struct pOS_ConsoleDevice" LINK "Device/Console.h/File" 35}
        @{"struct pOS_KeyMap" LINK "Device/Keymap.h/File" 18}@{b}

  INCLUDES@{ub}

        @{"Device/Input.h" LINK "Device/Input.h/File"}
        @{"Device/IEvent.h" LINK "Device/IEvent.h/File"}
        @{"pExec/Types.h" LINK "pExec/Types.h/File"}
        @{"pExec/Device.h" LINK "pExec/Device.h/File"}
        proto/pConsole2.h@{b}

  DESCRIPTION@{ub}

@ENDNODE
@NODE "CMDCD_AskKeyMap" "console.device/CMDCD_AskKeyMap()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_AskKeyMap@{b}

  FUNCTION@{ub}
          Determination of the present KeyMap

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to receive
                                    the IO-Request after execution of the command.
          io_Device,
          io_Unit          : Pointer to Device and Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_AskKeyMap

          io_Flags         : IOREQB_Quick, if Quick-IO is wanted
          io_Length        : Size of the pOS_KeyMap-Structure
          io_Data          : Pointer to the pOS_KeyMap-Structure, that is to
                             receive the KeyMap-Data.@{b}

  REMARK@{ub}
        The String io_Error has the Errorcode in the ReplyMsg
        or 0 if everything is ok.@{b}

  SEE ALSO@{ub}
        @{"CMDCD_SetKeyMap" LINK "CMDCD_SetKeyMap"}, @{"CMDCD_AskDefaultKeyMap" LINK "CMDCD_AskDefaultKeyMap"}@{b}

  AMIGA FUNCTION@{ub}
        CD_ASKKEYMAP

@ENDNODE
@NODE "CMDCD_SetKeyMap" "console.device/CMDCD_SetKeyMap()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_SetKeyMap@{b}

  FUNCTION@{ub}
          Setting of the present KeyMap

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to
                                    receive the IO-Request after Execution of the
                                    Command.
          io_Device,
          io_Unit          : Pointer to the Device and the Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_AskKeyMap

          io_Flags         : IOREQB_Quick, if Quick-IO is wanted
          io_Length        : Size of the pOS_KeyMap-Structure
          io_Data          : Pointer to the pOS_KeyMap-Structure, that contains
                             the KeyMap-Data.@{b}

  REMARK@{ub}
        The String io_Error contains the Errorcode in the ReplyMsg
        or 0 if all is ok.@{b}

  SEE ALSO@{ub}
        CMDCD_AksKeyMap, @{"CMDCD_SetDefaultKeyMap" LINK "CMDCD_SetDefaultKeyMap"}@{b}

  AMIGA FUNCTION@{ub}
        CD_SETKEYMAP

@ENDNODE
@NODE "CMDCD_AskDefaultKeyMap" "console.device/CMDCD_AskDefaultKeyMap()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_AskDefaultKeyMap@{b}

  FUNCTION@{ub}
          Determination of the present Preset-KeyMap

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to
                                    receive the IO-Request after Execution of the
                                    Command.
          io_Device,
          io_Unit          : Pointer to the Device and the Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_AskKeyMap

          io_Flags         : IOREQB_Quick, if Quick-IO is wanted
          io_Length        : Size of the pOS_KeyMap-Structure
          io_Data          : Pointer to the pOS_KeyMap-Structure, that is to
                             receive the Data of the Preset-KeyMap.@{b}

  REMARK@{ub}
        The String io_Error contains the Errorcode in the ReplyMsg
        or 0 if everything is ok.@{b}

  SEE ALSO@{ub}
        @{"CMDCD_SetDefaultKeyMap" LINK "CMDCD_SetDefaultKeyMap"}, @{"CMDCD_AskKeyMap" LINK "CMDCD_AskKeyMap"}@{b}

  AMIGA FUNCTION@{ub}
        CD_ASKDEFAULTKEYMAP

@ENDNODE
@NODE "CMDCD_SetDefaultKeyMap" "console.device/CMDCD_SetDefaultKeyMap()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_SetDefaultKeyMap@{b}

  FUNCTION@{ub}
          Setting of the present Preset-KeyMap

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to
                                    receive the IO-Request after Execution of the
                                   Command.
          io_Device,
          io_Unit          : Pointer to the Device and the Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_AskKeyMap

          io_Flags         : IOREQB_Quick, if Quick-IO is wanted
          io_Length        : Size of the pOS_KeyMap-Structure
          io_Data          : Pointer to the pOS_KeyMap-Structure, that is to
                             receive the Data of the Preset-KeyMap.@{b}

  REMARK@{ub}
        The String io_Error contains the Errorcode in the ReplyMsg
        or 0 if all is ok.@{b}

  SEE ALSO@{ub}
        @{"CMDCD_AskDefaultKeyMap" LINK "CMDCD_AskDefaultKeyMap"}, @{"CMDCD_SetKeyMap" LINK "CMDCD_SetKeyMap"}@{b}

  AMIGA FUNCTION@{ub}
        CD_SETDEFAULTKEYMAP

@ENDNODE
@NODE "CMDCD_InitStruct" "console.device/CMDCD_InitStruct()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_InitStruct@{b}

  FUNCTION@{ub}

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to
                                    receive the IO-Request after Execution of the
                                    Command.
          io_Device,
          io_Unit          : Pointer to the Device and the Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_InitStruct@{b}


  SEE ALSO@{ub}@{b}

  AMIGA FUNCTION@{ub}

@ENDNODE
@NODE "CMDCD_Slide" "console.device/CMDCD_Slide()"
@{b}

  PROTOTYPE@{ub}
        CMDCD_Slide@{b}

  FUNCTION@{ub}

        PARAMETER pOS_IOStdReq
          io_Message.mn_ReplyPort : Pointer to the Message-Port, that is to
                                    receive the IO-Request after Execution of the
                                    Command.
          io_Device,
          io_Unit          : Pointer to the Device and the Unit; initialized
                             through @{"pOS_OpenDevice()" LINK "pExecE/pOS_OpenDevice"}.
          io_Command       : CDCMD_Slide@{b}


  SEE ALSO@{ub}@{b}

  AMIGA FUNCTION@{ub}

@ENDNODE
@NODE "pOS_RawKeyConvert" "console.device/pOS_RawKeyConvert()"
@{b}

   NAME@{ub}
        pOS_RawKeyConvert -- Convert RawKey to ANSI@{b}

   SYNOPSIS@{ub}
        res =pOS_RawKeyConvert(IE,buffer,bufSize);
        @{"_R_D0" LINK "pExec/Types.h/File" 37}                 @{"_R_A0" LINK "pExec/Types.h/File" 28} @{"_R_A1" LINK "pExec/Types.h/File" 29}  @{"_R_D0" LINK "pExec/Types.h/File" 37}

        @{"size_t" LINK "pExec/Types.h/File" 113} pOS_RawKeyConvert(const pOS_InputEvent*,@{"UBYTE" LINK "pExec/Types.h/File" 95}*,@{"size_t" LINK "pExec/Types.h/File" 113});@{b}

   FUNCTION@{ub}@{b}

   INPUTS@{ub}
        IE      - RawKey-Input Event
        buffer  - the Buffer to fill
        bufSize - maximum Byte-Length of 'buffer'@{b}

   RESULT@{ub}
        Number of Characters in 'buffer'
        ~0 => an Error occured@{b}

   EXAMPLE@{ub}@{b}

   SEE ALSO@{ub}

@ENDNODE
@NODE "pOS_MapRawKey" "console.device/pOS_MapRawKey()"
@{b}

   NAME@{ub}
        pOS_MapRawKey -- convert RawKey to ANSI@{b}

   SYNOPSIS@{ub}
        res = pOS_MapRawKey(IE,buffer,bufSize,KeyMap);
        @{"_R_D0" LINK "pExec/Types.h/File" 37}              @{"_R_A0" LINK "pExec/Types.h/File" 28} @{"_R_A1" LINK "pExec/Types.h/File" 29} @{"_R_D0" LINK "pExec/Types.h/File" 37}   @{"_R_A2" LINK "pExec/Types.h/File" 30}

        @{"size_t" LINK "pExec/Types.h/File" 113} pOS_MapRawKey(const pOS_InputEvent*,@{"UBYTE" LINK "pExec/Types.h/File" 95}*,
                   @{"size_t" LINK "pExec/Types.h/File" 113},const pOS_KeyMap*);@{b}

   FUNCTION@{ub}@{b}

   INPUTS@{ub}
        IE      - RawKey-Input Event
        buffer  - the Buffer to fill
        bufSize - maximum Byte-Length of 'buffer'
        KeyMap  - KeyMap or @{"NULL" LINK "pExec/Types.h/File" 117}@{b}

   RESULT@{ub}
        Number of Characters in 'buffer'
        ~0 => an Error occured@{b}

   EXAMPLE@{ub}@{b}

   SEE ALSO@{ub}@{b}

  END@{ub}

@ENDNODE