Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Encodes a data space object description into a binary buffer

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

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

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

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

Hdf rm anchor
AnchorNameparameters

Comment (Hide)
Parameters:
HTML Wrap
classhdf-rm-section
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

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

See H5S_ENCODE2.

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
ReleaseChange
1.12.0

The function H5S_ENCODEwas ENCODE was renamed toH5Sto H5S_ENCODE1 and deprecated in this release.

The macro H5S_ENCODEand ENCODE and the functionH5Sfunction H5S_ENCODE2 were introduced in this release.

HTML Wrap
classhdf-rm-section