Encodes a data space object description into a binary buffer

Procedure:

H5S_ENCODE ( obj_id, buf, nalloc)

Signature:

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

Parameters:
hid_t obj_idIN: Identifier of the object to be encoded
unsigned char *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:

Given the data space ID, H5S_ENCODE converts a data space description into binary form in a buffer. Using this binary form in the buffer, a data space object can be reconstructed using H5S_DECODE to return a new object handle(hid_t) for this data space.

A preliminary H5S_ENCODE call can be made to find out the size of the buffer needed. This value is returned as nalloc. That value can then be assigned to nalloc for a second H5S_ENCODE call, which will retrieve the actual encoded object.

If the library finds out nalloc is not big enough for the object, it simply returns the size of the buffer needed through nalloc without encoding the provided buffer.

The types of data space we address in this function are null, scalar, and simple space. For simple data space, the information of selection, for example, hyperslab selection, is also encoded and decoded. Complex data space has not been implemented in the library.

Returns:

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

Example:

Coming Soon!

History:

None