$ioprint

Return or set the message level in the message frame.

$ioprint

$ioprint = MessageLevel

Parameters

MessageLevel—integer representing the sum of the message codes for the desired message types. If the sum of the codes is 0, no information is placed in the message frame. For more information, see I/O Message Levels.

Return Values

Integer indicating the types of I/O message sent to the message frame. If 0, the message frame is empty.

If an error occurs, $procerror contains a negative value that identifies the exact error.

Use

Allowed in all component types.

Checking for Information in the Message Frame

The following example shows how you can use $ioprint to determine whether there is any information in the message frame. If there is information, you can refer the user to it. If there is not, you can display an appropriate message. 

trigger retrieve
retrieve
if ($status)
   if ($status = -2)
      if ($ioprint)
         if ($$message)         ; $$MESSAGE is a specific message for when $status = -2
            message $text(1572) ; retrieve failed, see message frame
         endif
      else
         message $$message
      endif
   else
      if ($status = -3)
         if ($ioprint)
            message $text(1501) ; retrieve I/O error, see message frame
         else
            message $text(1760) ; retrieve error %%$entname not found
        endif
      endif
   endif
endif
return ($status)
end

Related Topics