H5Rpkg.h

00001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00002  * Copyright by The HDF Group.                                               *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
00013  * access to either file, you may request a copy from help@hdfgroup.org.     *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 /*
00017  * Programmer: Quincey Koziol <koziol@hdfgroup.org>
00018  *             Thursday, September 13, 2007
00019  *
00020  * Purpose:     This file contains declarations which are visible
00021  *              only within the H5R package. Source files outside the
00022  *              H5R package should include H5Rprivate.h instead.
00023  */
00024 #ifndef H5R_PACKAGE
00025 #error "Do not include this file outside the H5R package!"
00026 #endif
00027 
00028 #ifndef _H5Rpkg_H
00029 #define _H5Rpkg_H
00030 
00031 /* Get package's private header */
00032 #include "H5Rprivate.h"
00033 
00034 /* Other private headers needed by this file */
00035 #include "H5Fprivate.h"         /* File access                          */
00036 
00037 /**************************/
00038 /* Package Private Macros */
00039 /**************************/
00040 
00041 
00042 /****************************/
00043 /* Package Private Typedefs */
00044 /****************************/
00045 
00046 
00047 /*****************************/
00048 /* Package Private Variables */
00049 /*****************************/
00050 
00051 
00052 /******************************/
00053 /* Package Private Prototypes */
00054 /******************************/
00055 
00056 /* General functions */
00057 H5_DLL herr_t H5R_init(void);
00058 H5_DLL herr_t H5R_get_obj_type(H5F_t *file, hid_t dxpl_id, H5R_type_t ref_type,
00059     const void *_ref, H5O_type_t *obj_type);
00060 
00061 
00062 #endif /* _H5Rpkg_H */
00063