gpr_$set_icon_opt

GPR_$SET_ICON_OPT                 GPR Calls                  GPR_$SET_ICON_OPT


NAME
     gpr_$set_icon_opt - sets option for acquire-display behavior when window
     is an icon.

FORMAT
     gpr_$set_icon_opt (icon_opt, status)

DESCRIPTION
     Normally, when a program running in an iconized window tries to acquire
     the display, GPR blocks execution of the program.  GPR does not return
     from gpr_$acquire_display, and execution of the application is suspended
     until the icon returns to the window state.  Since gpr_$event_wait and
     gpr_$cond_event_wait both do an implicit acquire/release, GPR also blocks
     execution of applications waiting for events when they are in an iconized
     window.  This routine gives applications the option of continuing execu-
     tion when the window is iconized by the Display Manager.

   Input Parameters
     icon_opt
          The option to block/not block execution of the program when the win-
          dow is an icon, in gpr_$icon_opt_t format.  Possible values are

             ⊕  gpr_$ok_if_icon

             ⊕  gpr_$block_if_icon

   Output Parameters
     status
          Completion status, in status_$t format.

NOTES
     The purpose of this routine is to allow a program with multiple windows
     to continue executing when one window is an icon.
Museum
