Intermec 5055 Reference Guide

Page of 216
im_receive_input
5-60
im_receive_input
Purpose:
This function gets input from the source and places it into the received buffer. You can
use the im_get_length function after this function to get the input length.
Syntax:
#include "im5055.h"
IM_STATUS im_receive_input
    (IM_ORIGIN 
iAllowedSource,
    IM_UINT 
iTimeout,
    IM_ORIGIN far 
*lpReturnedSource,
    IM_UCHAR far 
*lpReturnedString);
IN Parameters:
iAllowedSource    Defines the available input source. Choose one or more of these
constants:
IM_LABEL_SELECT    Label selected.
IM_KEYBOARD_SELECT    Keypad selected.
IM_COM1_SELECT    COM1 selected.
IM_COM2_SELECT    COM2 selected.
IM_NET_SELECT    Network input.
IM_ALL_SELECT    All sources selected.
Use these variables to modify the input by performing a logical OR with the above input
sources.
IM_KEYCODE_ENABLE    Applies when the keyboard or a label is a source. Returns
each key pressed and its keycode, or returns one character of a label per call. Does not
echo to the screen. This is the functional equivalent of setting the input mode to
IM_DESKTOP.
Keyboard characters are returned as 4 bytes. The first byte is the ASCII code. The
second byte is the scan code, and the last 2 bytes are flags for modifier keys (Shift,
Control, and Alt).
iTimeout    Specifies the receive timeout period. Either enter a number from 1 to 65,534
to indicate the length of the timeout in milliseconds, or choose one of these constants:
IM_ZERO_TIMEOUT    No wait.
IM_INFINITE_TIMEOUT    Wait forever—the function will not return until the end of
message character has been received.
OUT Parameters:
lpReturnedSource    Specifies the actual input source and is one of these constants:
IM_NO_SELECT    No selection made.
IM_LABEL_SELECT    Label selected.
IM_KEYBOARD_SELECT    Keypad selected.