Intermec 5055 Reference Guide

Page of 216
im_receive_field
5-55
5
im_receive_field
Purpose:
This function manages an input field area on the screen. You can specify display
attributes for the field and control the length of the input data.
Syntax:
#include "im5055.h"
IM_STATUS im_receive_field
    (IM_ORIGIN 
iAllowedSource
,
    IM_UINT 
iTimeout
,
    IM_ATTRIBUTES 
iAttribute
    IM_ULONG 
iFlags
    IM_SHORT 
iAllowedLength
    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 selected.
IM_ALL_SELECT    All sources selected.
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 does not return until the end of
message character is received, a return is entered, or one of the conditions set with the
iFlags parameter is met. If COM1 is selected, IM_INFINITE_TIMEOUT acts like
IM_INFINITE_NET_TIMEOUT.
iAttribute    Specifies the display attributes. Choose one of these constants:
IM_NORMAL    Plain text.
IM_INVERSE    Inverse color text.
IM_UNDERLINE    Underlined text.
iFlags    Controls the field action. Choose one or more of these constants:
IM_ERASE_FIELD    Clear field data and display any field attributes on screen, filling
the field area. If this flag is not set, the old data is displayed and the field is padded with
blanks. Attributes are applied to the current row.