Intermec Janus 2020 Reference Manual - Im_Irl_Y

im_irl_y

3-64

im_irl_y

Purpose:

This procedure receives input from the designated communications port the

same as IRL ASCII input command Y. This procedure receives a single

block, not an entire file, and always clears input from the host and edits

reader commands from input. Unlike the other IRL instructions, the data is

not automatically displayed. For more information on IRL and command Y,

refer to the IRL Programming Reference Manual.

Syntax:

With Intrmecd_IO, Intrmecp_IO;

Use Intrmecd_IO, Intrmecp_IO;

procedure im_irl_y (

timeout      : In System.Word;

port         : In IM_COM_PORT;

term_char    : In Character;

prot_mode    : In IM_PROTOCOL_CMD;

irl_string   : Out String;

cmd_count    : Out System.Word;

status_code  : Out System.Word);

IN Parameters:

The timeout parameter is the receive timeout period. You can exit the

function before data is received or before the timeout occurs by performing

an application break sequence (see your JANUS user’s manual). The return

status indicates whether the function was successful, a timeout occurred, or

the application break was received.

The numeric range for timeout is from 1 to 65,534 ms. You can also use one

of the following constants:

IM_ZERO_TIMEOUT

No wait

IM_INFINITE_TIMEOUT

Wait forever

The port_id parameter identifies the communications port as follows:

IM_COM1

COM1

IM_COM2

COM2, scanner port (2010 and 2050)

IM_COM4

COM4 (RF only)

The term_char parameter is the end of message character needed to

terminate input from the communications port. The character is normally a

carriage return, but you can set it to any other character.