Decodes property list received in a binary object buffer and returns a new property list identifier

Procedure:

H5P_DECODE ( buf )

Signature:

<pre><code class="language-c">hid_t H5Pdecode( void *buf )</code></pre>

Parameters:

void *buf     IN: Buffer holding the encoded property list

Description:

Given an binary property list description in a buffer, H5P_DECODE reconstructs the HDF5 property list and returns an identifier for the new property list. The binary description of the property list is encoded by H5P_ENCODE.

Note that some properties cannot be encoded and therefore will not be available in the decoded property list. These properties are discussed in H5P_ENCODE.

The user is responsible for passing in the correct buffer.

The property list identifier returned by this function should be released with H5P_CLOSE when the identifier is no longer needed so that resource leaks will not develop.

Returns:

Returns an object identifier (non-negative) if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.10.0Function introduced in this release.