Encodes a data space object description into a binary buffer

Signature:

<pre><code class="language-c">herr_t H5Sencode ( hid_t obj_id, void *buf, size_t *nalloc ) </code></pre>

<pre><code class="language-c">herr_t H5Sencode ( hid_t obj_id,  void *buf, size_t *nalloc,  hid_t fapl_id )</code></pre>

Parameters:
hid_t obj_idIN: Identifier of the object to be encoded
void * buf    

IN/OUT: Buffer for the object to be encoded into

If the provided buffer is NULL, only the size of buffer needed is returned through nalloc.

size_t * nallocIN: The size of the allocated buffer
OUT: The size of the buffer needed

Description:

H5S_ENCODE is a macro that is mapped to either H5S_ENCODE1 or H5S_ENCODE2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. Their use and mappings are fully described in API Compatibility Macros in HDF5.

When both the HDF5 library and the application are built and installed with no specific compatibility flags, H5S_ENCODE is mapped to the most recent version of the function. If the library and/or application is compiled for Release 1.10 emulation, H5S_ENCODE will be mapped to H5S_ENCODE1.  Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

 

Compatibility settingH5S_ENCODE mapping
Global settings:
No compatibility flagH5S_ENCODE2
Enable deprecated symbolsH5S_ENCODE2
Disable deprecated symbols H5S_ENCODE2
Emulate Release 1.10 interface     H5S_ENCODE 1
Function-level macros:
H5Sencode_vers = 2 H5S_ENCODE2
H5Sencode_vers = 1 H5S_ENCODE 1

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

See H5S_ENCODE2.

History:
ReleaseChange
1.12.0

The function H5S_ENCODE was renamed to H5S_ENCODE1 and deprecated in this release.

The macro H5S_ENCODE and the function H5S_ENCODE2 were introduced in this release.