Candidate_v1.7.0
        stable
      
      
      
| Line |   | 
|---|
| 1 | /*!
 | 
|---|
| 2 |    \file read_entry.c
 | 
|---|
| 3 |    \ingroup (PSIO)
 | 
|---|
| 4 | */
 | 
|---|
| 5 | 
 | 
|---|
| 6 | #include <util/psi3/libpsio/psio.h>
 | 
|---|
| 7 | 
 | 
|---|
| 8 | namespace psi3 {
 | 
|---|
| 9 | namespace libpsio {
 | 
|---|
| 10 | 
 | 
|---|
| 11 | /*!
 | 
|---|
| 12 | ** PSIO_READ_ENTRY(): Reads an entire TOC entry from a PSI file.
 | 
|---|
| 13 | **
 | 
|---|
| 14 | **  \param unit   = The PSI unit number used to identify the file to all read
 | 
|---|
| 15 | **                  and write functions.
 | 
|---|
| 16 | **  \param key    = The TOC keyword identifying the desired entry.
 | 
|---|
| 17 | **  \param buffer = The buffer to store the data as it is read.
 | 
|---|
| 18 | **  \param size   = The number of bytes to read.
 | 
|---|
| 19 | **
 | 
|---|
| 20 | ** Note that the value of size is not directly compared to the actual
 | 
|---|
| 21 | ** size of the entry, but care is taken to ensure that the end of the
 | 
|---|
| 22 | ** entry is not surpassed.
 | 
|---|
| 23 | **
 | 
|---|
| 24 | ** \ingroup (PSIO)
 | 
|---|
| 25 | */
 | 
|---|
| 26 | 
 | 
|---|
| 27 | int psio_read_entry(unsigned int unit, char *key, char *buffer, ULI size)
 | 
|---|
| 28 | {
 | 
|---|
| 29 |   psio_address end;
 | 
|---|
| 30 |   return psio_read(unit, key, buffer, size, PSIO_ZERO, &end);
 | 
|---|
| 31 | }
 | 
|---|
| 32 | 
 | 
|---|
| 33 | }
 | 
|---|
| 34 | }
 | 
|---|
       
      
  Note:
 See   
TracBrowser
 for help on using the repository browser.