Intermec Janus 2020 Reference Manual - Im_Appl_Break_Status

im_appl_break_status

3-6

im_appl_break_status

Purpose:

This function checks whether the application break sequence has been

pressed. All PSK functions are terminated when the application break

sequence is keyed in.

Place calls to this function at strategic locations in your program to detect

when a user wants to break out of a loop. Your program can determine

what action to take when the break sequence is detected.

Syntax:

With Intrmecd_IO, Intrmecp_IO;

Use Intrmecd_IO, Intrmecp_IO;

   procedure im_appl_break_status (

break_status  : Out IM_APPBREAK_STATUS;

status_code   : Out System.Word);

IN Parameter:

None.

OUT Parameter:

The break_status parameter is one of the following constants:

IM_REQUEST_NOT_MADE

Request for an application break has not

been made

IM_REQUEST_MADE

Request for an application break has been

made

The status_code is one of the standard status codes defined in Appendix A,

“Status Codes.”

Return Value:

None.

Notes:

The break_status flag is reset each time this routine is called. Because this

function is also called during the input routines provided in the library, you

should check the return code from input functions for the hex value 8515H.

This value indicates that the input function has terminated because the

application break sequence was entered. In this case, the break_status flag is

cleared by the input function’s call to im_appl_break_status.