diff options
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/RM_H5P.html | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 0f4034e..0a67e9e 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -223,6 +223,7 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-SetExternal">H5Pset_external</a> <li><a href="#Property-GetExternalCount">H5Pget_external_count</a> <li><a href="#Property-GetExternal">H5Pget_external</a> + <li><a href="#Property-DeleteFilter">H5Pdelete_filter</a> </ul> <p><i>Dataset Access, Memory, and <br> Transfer Properties</i> @@ -282,6 +283,7 @@ See further notes in the description of each function. <li><a href="#Property-Create">H5Pcreate</a> <li><a href="#Property-CreateClass">H5Pcreate_class</a> <li><a href="#Property-CreateList">H5Pcreate_list</a> + <li><a href="#Property-Equal">H5Pdelete_filter</a> <li><a href="#Property-Equal">H5Pequal</a> <li><a href="#Property-Exist">H5Pexist</a> <li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a> @@ -508,6 +510,7 @@ as the corresponding C function. <li><a href="#Property-SetExternal">h5pset_external_f</a> <li><a href="#Property-GetExternalCount">h5pget_external_count_f</a> <li><a href="#Property-GetExternal">h5pget_external_f</a> + <li><a href="#Property-DeleteFilter">h5pdelete_filter_f</a> </ul> <!-- @@ -1186,6 +1189,61 @@ SUBROUTINE </dl> <!-- NEW PAGE --> +<!-- HEADER RIGHT "H5Pdelete_filter" --> +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-DeleteFilter">H5Pdelete_filter</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pdelete_filter</code>(<em>hid_t</em> <code>plist</code>, + <em>H5Z_filter_t</em> <code>filter</code> + ) + <dt><strong>Purpose:</strong> + <dd>Delete one or more filters in the filter pipeline. + <dt><strong>Description:</strong> + <dd><code>H5Pdelete_filter</code> removes the specified + <code>filter</code> from the filter pipeline. + <p> + Passing <code>H5Z_FILTER_NONE</code> for the <code>filter</code> + parameter removes all the filters from the permanent filter pipeline. + <p> + Attempting to remove a filter that is not in the permanent filter + pipeline is an error. + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + pipeline; <code>plist</code> must be a dataset creation + property list. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist_id</code> + <dd>IN: Property list identifier. + <dt><em>H5Z_filter_t</em> <code>filter</code> + <dd>IN: Type of filter to be deleted. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + + <dt><strong>Fortran90 Interface:</strong> h5pdelete_filter_f + <dd> + <pre> +SUBROUTINE h5pdelete_filter_f(prp_id, filter, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier + INTEGER, INTENT(IN) :: filter ! Filter to be modified + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure +END SUBROUTINE h5pdelete_filter_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + +<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Pequal" --> <hr> <dl> |