ireadmm.f

Go to the documentation of this file.

C> @file
C> @brief Read a specified BUFR message from internal arrays.

C> This function calls BUFRLIB subroutine readmm() and passes
C> back its return code as the function value.
C>
C> @author J. Woollen
C> @date 1999-11-18
C>
C> @param[in,out] IMSG -- integer: Message pointer within internal arrays
C>                        - On input, IMSG is the number of the BUFR
C>                          message to be read into scope for further
C>                          processing, counting from the beginning of
C>                          the internal arrays in memory
C>                        - On output, IMSG is incremented by one from
C>                          its input value
C> @param[out] SUBSET -- character*8: Table A mnemonic for type of BUFR
C>                       message that was read into scope
C>                       (see [DX BUFR Tables](@ref dfbftab) for
C>                       further information about Table A mnemonics)
C> @param[out] IDATE  -- integer: Date-time stored within Section 1 of
C>                       BUFR message that was read into scope,
C>                       in format of either YYMMDDHH or YYYYMMDDHH,
C>                       depending on the most
C>                       recent call to subroutine datelen()
C> @returns ireadmm   -- integer:
C>                          - 0 = new BUFR message was successfully
C>                                read into scope
C>                          - -1 = requested message number could not
C>                                 be found in internal arrays
C>
C> @remarks
C> - The use of this function allows the return code from readmm() to be
C> used as the target variable within an iterative program loop.
C>
C> <b>Program history log:</b>
C> | Date | Programmer | Comments |
C> | -----|------------|----------|
C> | 1999-11-18 | J. Woollen | Original author |
C> | 2002-05-14 | J. Woollen | Changed from an entry point to increase portability to other platforms |
C>
      FUNCTION ireadmm(IMSG,SUBSET,IDATE)

      CHARACTER*8 subset

C-----------------------------------------------------------------------
C-----------------------------------------------------------------------

      CALL readmm(imsg,subset,idate,iret)
      ireadmm = iret

      RETURN
      END