mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-04-12 17:31:09 +08:00
[svn-r3104]
Purpose:
Finalize new API function descriptions
Description:
Edits to recently-added APIs:
H5Pset_sieve_buf_size H5Pset_fapl_log
H5P[sg]et_fapl_mpio H5Pset_fapl_multi
H5P[sg]et_dxpl_multi H5Pset_fapl_split
H5P[sg]et_fapl_gass H5Pset_fapl_dpss
H5P[sg]et_fapl_srb
Added H5P[sg]et_fapl_core.
Addition of new APIs for R1.4 is now complete.
Moved H5Pset_driver and H5Pget_driver_info to TechNotes.
Platforms tested:
IE 5
This commit is contained in:
Frank Baker
parent
7bb514d358
commit
15df4a2679
@ -57,7 +57,7 @@ many different parameters to be easily manipulated.
|
||||
<table border=0>
|
||||
<tr><td valign=top>
|
||||
|
||||
<i>General Property List Operations</i>
|
||||
<i>General Property List <br> Operations</i>
|
||||
<ul>
|
||||
<li><a href="#Property-Create">H5Pcreate</a>
|
||||
<li><a href="#Property-GetClass">H5Pget_class</a>
|
||||
@ -78,18 +78,16 @@ many different parameters to be easily manipulated.
|
||||
<li><a href="#Property-GetIstoreK">H5Pget_istore_k</a>
|
||||
</ul>
|
||||
|
||||
<p><i>Variable-length Datatype Properties</i>
|
||||
<ul>
|
||||
<li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
|
||||
<li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|| <i>Indicates functions available <br>
|
||||
only in the parallel HDF5 library.</i>
|
||||
|| <i>Indicates functions <br>
|
||||
available only in the <br>
|
||||
parallel HDF5 library.</i>
|
||||
|
||||
</td><td> </td><td valign=top>
|
||||
|
||||
@ -107,9 +105,9 @@ many different parameters to be easily manipulated.
|
||||
<li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a>
|
||||
<li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a>
|
||||
<li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a>
|
||||
<li><a href="#Property-SetDriver">H5Pset_driver</a>
|
||||
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
|
||||
<li><a href="#Property-GetDriver">H5Pget_driver</a>
|
||||
<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a>
|
||||
<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> -->
|
||||
<li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
|
||||
<li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a>
|
||||
<li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
|
||||
@ -165,6 +163,8 @@ many different parameters to be easily manipulated.
|
||||
<li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a>
|
||||
<li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a>
|
||||
<li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a>
|
||||
<li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
|
||||
<li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
|
||||
<li><a href="#Property-SetDxplMpio">H5Pset_dxpl_mpio</a> ||
|
||||
<li><a href="#Property-GetDxplMpio">H5Pget_dxpl_mpio</a> ||
|
||||
<li><a href="#Property-SetDxplMulti">H5Pset_dxpl_multi</a>
|
||||
@ -1601,23 +1601,26 @@ facilitate moving easily between them.</i>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>xxx</em> <code>H5Pset_sieve_buf_size</code>(
|
||||
<dd><em>herr_t</em> <code>H5Pset_sieve_buf_size</code>(
|
||||
<em>hid_t</em> <code>fapl_id</code>,
|
||||
<em>hsize_t</em> <code>size</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>
|
||||
<dd>Sets the maximum size of the data sieve buffer.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Pset_sieve_buf_size</code> sets <code>size</code>,
|
||||
the maximum size in bytes of the data seive buffer, which is
|
||||
the maximum size in bytes of the data sieve buffer, which is
|
||||
used by file drivers that are capable of using data sieving.
|
||||
<p>
|
||||
The data sieve buffer is used when performing I/O on datasets in the file. Using a buffer which is large anough to hold several pieces of the dataset being read in for hyperslab selections boosts performance by quite a bit.
|
||||
The data sieve buffer is used when performing I/O on datasets
|
||||
in the file. Using a buffer which is large anough to hold
|
||||
several pieces of the dataset being read in for
|
||||
hyperslab selections boosts performance by quite a bit.
|
||||
<p>
|
||||
The default value is set to 64KB, indicating that file I/O for raw data reads and writes will occur in at least 64KB blocks. Setting the value to 0 with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy.
|
||||
<p>
|
||||
<b><i><font color=red>Need a conceptual understanding of data sieving to finish this. -- FB</font></i></b>
|
||||
|
||||
The default value is set to 64KB, indicating that file I/O for
|
||||
raw data reads and writes will occur in at least 64KB blocks.
|
||||
Setting the value to 0 with this API function will turn off the
|
||||
data sieving, even if the VFL driver attempts to use that strategy.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>
|
||||
@ -2641,18 +2644,38 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Sets up the use of the logging driver.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_log</code> modifies the
|
||||
file access property list to use the logging driver .
|
||||
<b><i><font color=red>(H5FD_LOG ??)</font></i></b>
|
||||
<dd><code>H5Pset_fapl_log</code> modifies the
|
||||
file access property list to use the logging driver
|
||||
<code>H5FD_LOG</code>.
|
||||
There are no driver-specific properties.
|
||||
<p>
|
||||
<code>logfile</code> is the name of the file in which the
|
||||
logging entries are to be recorded.
|
||||
<p>
|
||||
<code>verbosity</code> indicates the extent of the logging
|
||||
activity intended, with a value of <code>0</code> indicating
|
||||
no logging.
|
||||
<b><font color=red>(Other values, range, ... ??)</font></b>
|
||||
activity intended. Valid values are as follows:
|
||||
<center>
|
||||
<table width=75%>
|
||||
<tr valign=top align=left><td>
|
||||
<code>0</code>
|
||||
</td><td>
|
||||
Performs no logging.
|
||||
</td></tr>
|
||||
<tr valign=top align=left><td>
|
||||
<code>1</code>
|
||||
</td><td>
|
||||
Records where writes and reads occur in the file.
|
||||
</td></tr>
|
||||
<tr valign=top align=left><td>
|
||||
<code>2</code>
|
||||
</td><td>
|
||||
Records where writes and reads occur in the file and what
|
||||
kind of data is written at each location: raw data or any of
|
||||
several types of metadata (object headers, superblock,
|
||||
B-tree data, local headers, or global headers).
|
||||
</td></tr>
|
||||
</table>
|
||||
</center>
|
||||
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
@ -2688,12 +2711,13 @@ facilitate moving easily between them.</i>
|
||||
<em>MPI_Info</em> <code>info</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Stores MPIO communicator information to the file access property list.
|
||||
<dd>Stores MPI IO communicator information to the file access property list.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Pset_fapl_mpio</code> stores the user supplied
|
||||
MPIO communicator <code>comm</code> and <code>info</code> in
|
||||
the file access property list <code>fapl_id</code>,
|
||||
which can then be used to create and/or open the file.
|
||||
<dd><code>H5Pset_fapl_mpio</code> stores the user-supplied
|
||||
MPI IO parameters <code>comm</code>, for communicator, and
|
||||
<code>info</code>, for information, in
|
||||
the file access property list <code>fapl_id</code>.
|
||||
That property list can then be used to create and/or open the file.
|
||||
<p>
|
||||
<code>H5Pset_fapl_mpio</code> is available only in the
|
||||
parallel HDF5 library and is not a collective function.
|
||||
@ -2749,8 +2773,8 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd> Returns MPI communicator information.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd>If the file access property list is set to the H5FD_MPIO driver,
|
||||
<code>H5Pget_fapl_mpio</code> returns the MPI communicator and
|
||||
<dd>If the file access property list is set to the <code>H5FD_MPIO</code>
|
||||
driver, <code>H5Pget_fapl_mpio</code> returns the MPI communicator and
|
||||
information through the <code>comm</code> and <code>info</code>
|
||||
pointers, if those values are non-null.
|
||||
<p>
|
||||
@ -2886,6 +2910,17 @@ facilitate moving easily between them.</i>
|
||||
<dd><code>H5Pset_fapl_multi</code> sets the file access property list
|
||||
<code>fapl_id</code> to use the multi-file driver.
|
||||
<p>
|
||||
The multi-file driver enables different types of HDF5 data and
|
||||
metadata to be written to separate files. These files are viewed
|
||||
by the HDF5 library and the application as a single virtual HDF5 file
|
||||
with a single HDF5 file address space.
|
||||
The types of data that can be broken out into separate file include
|
||||
raw data, the superblock, B-tree data, global heap data,
|
||||
local heap data, and object headers.
|
||||
At the programmer's discretion, two or more types of data can be
|
||||
written the same file while other types of data are written to
|
||||
separate files.
|
||||
<p>
|
||||
The array <code>memb_map</code> maps memory usage types to other
|
||||
memory usage types and is the mechanism that allows the caller
|
||||
to specify how many files are created.
|
||||
@ -2903,7 +2938,9 @@ facilitate moving easily between them.</i>
|
||||
name passed to <code>H5FDopen()</code>, usually from
|
||||
<code>H5Fcreate()</code> or <code>H5Fopen()</code>).
|
||||
<p>
|
||||
The array <code>memb_addr</code> ....
|
||||
The array <code>memb_addr</code> specifies the offsets within the
|
||||
virtual address space, from <code>0</code> (zero) to
|
||||
<code>HADDR_MAX</code>, at wihch each type of data storage begins.
|
||||
<p>
|
||||
If <code>relax</code> is set to <code>TRUE</code> (or <code>1</code>),
|
||||
then opening an existing file for read-only access will not fail
|
||||
@ -2924,17 +2961,17 @@ facilitate moving easily between them.</i>
|
||||
where <code><i>X</i></code> is one of the
|
||||
following letters:
|
||||
<dir>
|
||||
<code>s</code> for <code>H5FD_MEM_SUPER</code>
|
||||
<code>s</code> for <code>H5FD_MEM_SUPER</code>
|
||||
<br>
|
||||
<code>b</code> for <code>H5FD_MEM_BTREE</code>
|
||||
<code>b</code> for <code>H5FD_MEM_BTREE</code>
|
||||
<br>
|
||||
<code>r</code> for <code>H5FD_MEM_DRAW</code>
|
||||
<code>r</code> for <code>H5FD_MEM_DRAW</code>
|
||||
<br>
|
||||
<code>g</code> for <code>H5FD_MEM_GHEAP</code>
|
||||
<code>g</code> for <code>H5FD_MEM_GHEAP</code>
|
||||
<br>
|
||||
<code>l</code> for <code>H5FD_MEM_LHEAP</code>
|
||||
<code>l</code> for <code>H5FD_MEM_LHEAP</code>
|
||||
<br>
|
||||
<code>o</code> for <code>H5FD_MEM_OHDR</code>
|
||||
<code>o</code> for <code>H5FD_MEM_OHDR</code>
|
||||
</dir>
|
||||
<dt><code>memb_addr</code>
|
||||
<dd>The default value is <code>HADDR_UNDEF</code> for each element.
|
||||
@ -2951,7 +2988,9 @@ facilitate moving easily between them.</i>
|
||||
<dt><em>const char **</em><code>memb_name</code>
|
||||
<dd>IN: Name generator for names of member files.
|
||||
<dt><em>const haddr_t *</em><code>memb_addr</code>
|
||||
<dd>IN:
|
||||
<dd>IN: The offsets within the virtual address space,
|
||||
from <code>0</code> (zero) to <code>HADDR_MAX</code>,
|
||||
at wihch each type of data storage begins.
|
||||
<dt><em>hbool_t</em> <code>relax</code>
|
||||
<dd>IN: Allows read-only access to incomplete file sets
|
||||
when <code>TRUE</code>.
|
||||
@ -3061,14 +3100,16 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Pset_dxpl_multi</code> sets the data transfer property list
|
||||
<code>dxpl_id</code> to use the multi-file driver for each
|
||||
memory usage type <code>memb_dxpl[]</code>
|
||||
(after the usage map is applied).
|
||||
memory usage type <code>memb_dxpl[]</code>.
|
||||
<p>
|
||||
<code>H5Pset_dxpl_multi</code> can only be used after
|
||||
the member map has been set with <code>H5Pset_fapl_multi</code>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>dxpl_id</code>,
|
||||
<dd>IN: Data transfer property list identifier.
|
||||
<dt><em>const hid_t *</em><code>memb_dxpl</code>
|
||||
<dd>IN: Array of memory usage types for ...
|
||||
<dd>IN: Array of data access property lists.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
@ -3105,7 +3146,7 @@ facilitate moving easily between them.</i>
|
||||
<dt><em>hid_t</em> <code>dxpl_id</code>,
|
||||
<dd>IN: Data transfer property list identifier.
|
||||
<dt><em>const hid_t *</em><code>memb_dxpl</code>
|
||||
<dd>OUT: Array of memory usage types for ...
|
||||
<dd>OUT: Array of data access property lists.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
@ -3138,32 +3179,34 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Pset_fapl_split</code> is a compatability function that
|
||||
enables the multi-file driver to emulate the split driver from
|
||||
HDF5 Releases 1.0 and 1.2.
|
||||
HDF5 Releases 1.0 and 1.2.
|
||||
The split file driver stored metadata and raw data in separate files
|
||||
but provide no mechanism for separating types of metadata.
|
||||
<p>
|
||||
<code>fapl_id</code> is ....
|
||||
<code>fapl_id</code> is a file access property list identifier.
|
||||
<p>
|
||||
<code>meta_ext</code> is ....
|
||||
<code>meta_ext</code> is the filename extension for the metadata file.
|
||||
<p>
|
||||
<code>meta_plist_id</code> is the file property list identifier for
|
||||
the meta data file.
|
||||
<code>meta_plist_id</code> is the file access property list identifier
|
||||
for the metadata file.
|
||||
<p>
|
||||
<code>raw_ext</code> is ....
|
||||
<code>raw_ext</code> is the filename extension for the raw data file.
|
||||
<p>
|
||||
<code>raw_plist_id</code> is the file property list identifier for
|
||||
the raw data file.
|
||||
<code>raw_plist_id</code> is the file access property list identifier
|
||||
for the raw data file.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>,
|
||||
<dd>IN:
|
||||
<dd>IN: File access property list identifier.
|
||||
<dt><em>const char *</em><code>meta_ext</code>,
|
||||
<dd>IN:
|
||||
<dd>IN: Metadata filename extension.
|
||||
<dt><em>hid_t</em> <code>meta_plist_id</code>,
|
||||
<dd>IN:
|
||||
<dd>IN: File access property list identifier for the metadata file.
|
||||
<dt><em>const char *</em><code>raw_ext</code>,
|
||||
<dd>IN:
|
||||
<dd>IN: Raw data filename extension.
|
||||
<dt><em>hid_t</em> <code>raw_plist_id</code>
|
||||
<dd>IN:
|
||||
<dd>IN: File access property list identifier for the raw data file.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
@ -3184,13 +3227,13 @@ facilitate moving easily between them.</i>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetFaplSec2">H5Pset_fapl_sec2</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t</em> <code>H5Psget_fapl_sec2</code>(
|
||||
<dd><em>herr_t</em> <code>H5Pset_fapl_sec2</code>(
|
||||
<em>hid_t</em> <code>fapl_id</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Sets the sec2 driver.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_sec2</code> modifies the file access property list
|
||||
<dd><code>H5Pset_fapl_sec2</code> modifies the file access property list
|
||||
to use the <code>H5FD_SEC2</code> driver.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
@ -3216,13 +3259,13 @@ facilitate moving easily between them.</i>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetFaplStdio">H5Pset_fapl_stdio</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t</em> <code>H5Psget_fapl_stdio</code>(
|
||||
<dd><em>herr_t</em> <code>H5Pset_fapl_stdio</code>(
|
||||
<em>hid_t</em> <code>fapl_id</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Sets the standard I/O driver.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_stdio</code> modifies the file access property list
|
||||
<dd><code>H5Pset_fapl_stdio</code> modifies the file access property list
|
||||
to use the standard I/O driver, <code>H5FD_STDIO</code>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
@ -3363,6 +3406,8 @@ facilitate moving easily between them.</i>
|
||||
</dl>
|
||||
|
||||
|
||||
<!-- ********** MOVED TO TechNotes/VFLfunc.html **********
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetDriver">H5Pset_driver</a>
|
||||
@ -3399,17 +3444,15 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
Otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
-->
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
@ -3447,6 +3490,8 @@ facilitate moving easily between them.</i>
|
||||
</dl>
|
||||
|
||||
|
||||
<!-- ********** MOVED TO TechNotes/VFLfunc.html **********
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-GetDriverInfo">H5Pget_driver_info</a>
|
||||
@ -3483,30 +3528,28 @@ facilitate moving easily between them.</i>
|
||||
<code>NULL</code> is also returned if no driver-specific properties
|
||||
have been registered.
|
||||
No error is pushed on the stack in this case.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
-->
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetFaplGass">H5Pset_fapl_gass</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t</em> <code>H5Psget_fapl_gass</code>(
|
||||
<dd><em>herr_t</em> <code>H5Pset_fapl_gass</code>(
|
||||
<em>hid_t</em> <code>fapl_id</code>,
|
||||
<em>GASS_Info</em> <code>info</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Stores user-supplied GASS information.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_gass</code> stores user-supplied GASS information,
|
||||
<dd><code>H5Pset_fapl_gass</code> stores user-supplied GASS information,
|
||||
the <em>GASS_Info</em> struct data as passed in <code>info</code>,
|
||||
to the file access property list <code>fapl_id</code>.
|
||||
<code>fapl_id</code> can then be used to create and/or open the file.
|
||||
@ -3516,23 +3559,20 @@ facilitate moving easily between them.</i>
|
||||
<p>
|
||||
Any modification to <code>info</code> after this function call
|
||||
returns may have undetermined effect to the access property list.
|
||||
Users must call <code>H5Psget_fapl_gass</code> again to setup
|
||||
Users must call <code>H5Pset_fapl_gass</code> again to setup
|
||||
the property list.
|
||||
<dt><strong>Note:</strong>
|
||||
<dd><code>H5Psget_fapl_gass</code> is an experimental function.
|
||||
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
|
||||
It is designed for use only when accessing files via the
|
||||
GASS facility of the Globus environment.
|
||||
<font color=red><b><i>URL ??</i></b></font>
|
||||
For further information, see
|
||||
<a href="http://www.globus.org/">http//www.globus.org/</a>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>,
|
||||
<dd>IN: File access property list identifier.
|
||||
<dt><em>GASS_Info</em> <code>info</code>
|
||||
<dd>IN: Pointer to the GASS information structure.
|
||||
|
||||
<p>
|
||||
<font color=red><b><i>Need GASS_Info struct.</i></b></font>
|
||||
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
@ -3571,17 +3611,14 @@ facilitate moving easily between them.</i>
|
||||
<dd><code>H5Pget_fapl_gass</code> is an experimental function.
|
||||
It is designed for use only when accessing files via the
|
||||
GASS facility of the Globus environment.
|
||||
<font color=red><b><i>URL ??</i></b></font>
|
||||
For further information, see
|
||||
<a href="http://www.globus.org/">http//www.globus.org/</a>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>,
|
||||
<dd>IN: File access property list identifier.
|
||||
<dt><em>GASS_Info *</em><code>info</code>
|
||||
<dd>OUT: Pointer to the GASS information structure.
|
||||
|
||||
<p>
|
||||
<font color=red><b><i>Need GASS_Info struct.</i></b></font>
|
||||
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
@ -3615,13 +3652,15 @@ facilitate moving easily between them.</i>
|
||||
<dd><code>H5Pget_fapl_dpss</code> is an experimental function.
|
||||
It is designed for use only when accessing files via the
|
||||
DPSS facility of the Globus environment.
|
||||
<font color=red><b><i>URL ??</i></b></font>
|
||||
For further information, see
|
||||
<a href="http://www.globus.org/">http//www.globus.org/</a>.
|
||||
<p>
|
||||
As of HDF5 Release 1.4 Beta, the Globus project has deprecated
|
||||
the DPSS facility in favor of an FTP-based facility, which is still
|
||||
the DPSS facility in favor of an FTP-based facility that is still
|
||||
under development.
|
||||
While the DPSS functionality is still available,
|
||||
it may be unavailable in future Globus releases.
|
||||
users must be aware that it was implemented purely for research purposes
|
||||
and may be unavailable in future Globus releases.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>
|
||||
@ -3664,8 +3703,8 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Note:</strong>
|
||||
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
|
||||
It is designed for use only when accessing files via the
|
||||
GASS facility of the Storage Resource Broker (SRB).
|
||||
<font color=red><b><i>URL ??</i></b></font>
|
||||
Storage Resource Broker (SRB). For further information, see
|
||||
<a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>fapl_id</code>
|
||||
@ -3711,8 +3750,8 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Note:</strong>
|
||||
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
|
||||
It is designed for use only when accessing files via the
|
||||
GASS facility of the Storage Resource Broker (SRB).
|
||||
<font color=red><b><i>URL ??</i></b></font>
|
||||
Storage Resource Broker (SRB). For further information, see
|
||||
<a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dl>
|
||||
@ -3738,17 +3777,22 @@ facilitate moving easily between them.</i>
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SGetFaplxxx">H5Psget_fapl_xxx</a>
|
||||
<dt><strong>Name:</strong> <a name="Property-SetFaplCore">H5Pset_fapl_core</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>xxx</em> <code>H5Psget_fapl_xxx</code>(
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>
|
||||
<dd><em>herr_t</em> <code>H5Pset_fapl_core</code>(
|
||||
<em>hid_t</em> <code>fapl_id</code>,
|
||||
<em>size_t</em> <code>increment</code>,
|
||||
<em>hbool_t</em> <code>backing_store</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>
|
||||
<dd>Modifies the file access property list to use the
|
||||
<code>H5FD_CORE</code> driver.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_xxx</code>
|
||||
<dd><code>H5Pset_fapl_core</code> modifies the file access property list
|
||||
to use the <code>H5FD_CORE</code> driver.
|
||||
<p>
|
||||
<code>increment</code> specifies the increment by which allocated memory
|
||||
is to be increased each time more memory is required.
|
||||
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
@ -3771,8 +3815,83 @@ facilitate moving easily between them.</i>
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-GetFaplCore">H5Pget_fapl_core</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>xxx</em> <code>H5Pget_fapl_core</code>(
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Pget_fapl_core</code>
|
||||
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>xxx</em> <code>xxx</code>
|
||||
<dd>IN:
|
||||
<dd>OUT:
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
Otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<!-- ***** TEMPLATE *****
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-SGetFaplxxx">H5Psget_fapl_xxx</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>xxx</em> <code>H5Psget_fapl_xxx</code>(
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>,
|
||||
<em>xxx</em> <code>xxx</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Psget_fapl_xxx</code>
|
||||
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>xxx</em> <code>xxx</code>
|
||||
<dd>IN:
|
||||
<dd>OUT:
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful.
|
||||
Otherwise returns a negative value.
|
||||
-->
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
<!--
|
||||
</dl>
|
||||
-->
|
||||
|
||||
|
||||
<!-- ***** TEMPLATE *****
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Property-xxx">xxx</a>
|
||||
@ -3796,6 +3915,7 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns xxx if successful.
|
||||
Otherwise returns xxx.
|
||||
-->
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
|
||||
@ -3805,7 +3925,9 @@ facilitate moving easily between them.</i>
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
<!--
|
||||
</dl>
|
||||
-->
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user