You are viewing an old version of this page. View the current version.
Encodes the property values in a property list into a binary buffer
H5P_ENCODE ( plist_id, buf, nalloc )
herr_t H5Pencode( hid_t plist_id, void *buf, size_t *nalloc )
Replace this text with the C++ Function Signature
Replace this text with the JAVA Function Signature
|hid_t ||IN: Identifier of the property list to be encoded|
|void *||OUT: Buffer into which the property list will be encoded |
If the provided buffer is
|size_t *||OUT: The size of the required buffer|
H5P_ENCODE encodes the property list
plist_id into the binary buffer
If the required buffer size is unknown,
buf can be passed in as
NULL and the function will set the required buffer size in
nalloc. The buffer can then be created and the property list encoded with a subsequent
If the buffer passed in is not big enough to hold the encoded properties, the
call can be expected to fail with a segmentation fault.
Properties that do not have encode callbacks will be skipped. There is currently no mechanism to register an encode callback for a user-defined property, so user-defined properties cannot currently be encoded.
Some properties cannot be encoded, particularly properties that are reliant on local context.
Returns a non-negative value if successful; otherwise returns a negative value.
|1.10.0||Function introduced in this release.|