QMHRCVPM()--Receive Program Message for i5/OS PASE

 #include <os400msg.h>

 int QMHRCVPM(void         *msginfo,
              int          msginfoLen,    
              const char   *format,
              const char   *pgmq,
              int          pgmqDelta,
              const char   *msgtype,
              int          *msgkey,
              int          wait,
              const char   *action,
              void         *errcode);

 int QMHRCVPM1(void        *msginfo,
               int         msginfoLen,
               const char  *format,
               const char  *pgmq,
               int         pgmqDelta,
               const char  *msgtype,
               int         *msgkey,
               int         wait,
               const char  *action,
               void        *errcode,
               int         pgmqLen,
               const char  *pgmqQual);

 int QMHRCVPM2(void        *msginfo,
               int         msginfoLen,
               const char  *format,
               const void  *pgmq,
               int         pgmqDelta,
               const char  *msgtype,
               int         *msgkey,
               int         wait,
               const char  *action,
               void        *errcode,
               int         pgmqLen,
               const char  *pgmqQual,
               const char  *pgmqType,
               int         ccsid);

Note: These functions can only be used in an i5/OS PASE program. See i5/OS PASE for more information about creating i5/OS PASE programs.

The Receive Program Message (QMHRCVPM, QMHRCVPM1, and QMHRCVPM2) i5/OS PASE runtime functions allow an i5/OS PASE program to receive a message from a program call message queue or from the job external message queue.

Parameters

These i5/OS PASE runtime functions accept the same arguments as the Receive Program Message (QMHRCVPM) i5/OS API, except that the i5/OS PASE functions use character string inputs that are null-terminated strings in the i5/OS PASE CCSID. i5/OS PASE runtime automatically converts input character strings to the job default CCSID and pads with blanks (as necessary) to match the fixed-length inputs required by the system API.

No conversions are done by i5/OS PASE runtime for the msginfo and errcode (input/output) arguments because they can contain a mixture of character and binary data. The ccsid argument specifies the CCSID for character data returned by the system API in the msginfo argument, and users can request CCSID information for the errcode argument by using ERRC0200 format. The QMHRCVPM and QMHRCVPM1 i5/OS PASE runtime functions use a default for the ccsid value passed to the system API that does not do any CCSID conversion for character data in the received message.

See QMHRCVPM()--Receive Program Message for further description of the arguments for the QMHRCVPM, QMHRCVPM1, and QMHRCVPM2 i5/OS PASE runtime functions.

Authorities

See QMHRCVPM()--Receive Program Message for information about authorities required for the QMHRCVPM, QMHRCVPM1, and QMHRCVPM2 i5/OS PASE runtime functions.

Return Value

The function result is zero for normal completion. The result is nonzero if any input character string could not be converted to the job default CCSID or was too long for the QMHRCVPM API, or if the QMHRCVPM API returned error information in the errcode argument.

Usage Notes

1. The system only creates program call message queues ILE procedures and OMI programs, so you cannot send to or receive from a program message queue for a specific function in an i5/OS PASE program.
2. When "*" is specified for the pgmq argument, the system locates the program call message queue for an (internal) ILE procedure in service program QP2USER that is the apparent caller of any ILE procedure called by the i5/OS PASE program using i5/OS PASE runtime function _ILECALLX or _ILECALL. This queue is the target for messages a called ILE procedure sends to its caller, and is also used for machine exceptions caused by operations inside the i5/OS PASE program (such as message MCH0601 a for storage reference error).

Related Information

• QMHRCVPM()--Receive Program Message (system API)
  
  
• QMHRCVPM()--Receive Program Message for i5/OS PASE
  
  
• QMHSNDM()--Send Nonprogram Message for i5/OS PASE
  
  
• QMHRCVM()--Receive Nonprogram Message for i5/OS PASE