NCEPLIBS-bufr  11.5.0
 All Data Structures Files Functions Variables Pages
ireadmm.f
Go to the documentation of this file.
1 C> @file
2 C> @brief Read a specified BUFR message from internal arrays.
3 
4 C> This function calls BUFRLIB subroutine readmm() and passes
5 C> back its return code as the function value.
6 C>
7 C> @author J. Woollen
8 C> @date 1999-11-18
9 C>
10 C> @param[in,out] IMSG - integer: Message pointer within internal arrays
11 C> - On input, IMSG is the number of the BUFR
12 C> message to be read into scope for further
13 C> processing, counting from the beginning of
14 C> the internal arrays in memory
15 C> - On output, IMSG is incremented by one from
16 C> its input value
17 C> @param[out] SUBSET - character*8: Table A mnemonic for type of BUFR
18 C> message that was read into scope
19 C> (see [DX BUFR Tables](@ref dfbftab) for
20 C> further information about Table A mnemonics)
21 C> @param[out] IDATE - integer: Date-time stored within Section 1 of
22 C> BUFR message that was read into scope,
23 C> in format of either YYMMDDHH or YYYYMMDDHH,
24 C> depending on the most
25 C> recent call to subroutine datelen()
26 C> @returns ireadmm - integer:
27 C> - 0 = new BUFR message was successfully
28 C> read into scope
29 C> - -1 = requested message number could not
30 C> be found in internal arrays
31 C>
32 C> @remarks
33 C> - The use of this function allows the return code from readmm() to be
34 C> used as the target variable within an iterative program loop.
35 C>
36 C> <b>Program history log:</b>
37 C> - 1999-11-18 J. Woollen -- Original author
38 C> - 2002-05-14 J. Woollen -- Changed from an entry point to increase
39 C> portability to other platforms
40 C>
41  FUNCTION ireadmm(IMSG,SUBSET,IDATE)
42 
43  CHARACTER*8 subset
44 
45 C-----------------------------------------------------------------------
46 C-----------------------------------------------------------------------
47 
48  CALL readmm(imsg,subset,idate,iret)
49  ireadmm = iret
50 
51  RETURN
52  END
function ireadmm(IMSG, SUBSET, IDATE)
This function calls BUFRLIB subroutine readmm() and passes back its return code as the function value...
Definition: ireadmm.f:41
subroutine readmm(IMSG, SUBSET, JDATE, IRET)
This subroutine reads a specified BUFR message from internal arrays in memory, so that it is now in s...
Definition: readmm.f:58