- Created by Barbara Jones, last modified on Nov 16, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
H5P_ENCODE
Encodes the property values in a property list into a binary buffer
Procedure:
H5P_ENCODE ( plist_id, buf, nalloc )
Signature:
herr_t H5Pencode(
hid_t plist_id,
void *buf,
size_t *nalloc
)
None
Replace this text with the C++ Function Signature
Replace this text with the JAVA Function Signature
Parameters:
hid_t plist_id | IN: Identifier of the property list to be encoded |
void *buf | OUT: Buffer into which the property list will be encoded If the provided buffer is NULL, the size of the buffer required is returned through nalloc; the function does nothing more. |
size_t *nalloc | OUT: The size of the required buffer |
Description:
H5P_ENCODE encodes the property list plist_id into the binary buffer buf.
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 H5P_ENCODE call.
If the buffer passed in is not big enough to hold the encoded properties, the H5P_ENCODE
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:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
int
main (void)
{
hsize_t dims[2], dimsm[2];
int data[DIM0][DIM1]; /* data to write */
int sdata[DIM0_SUB][DIM1_SUB]; /* subset to write */
int rdata[DIM0][DIM1]; /* buffer for read */
hid_t file_id, dataset_id; /* handles */
hid_t dataspace_id, memspace_id;
PROGRAM COMPOUNDEXAMPLE
USE HDF5 ! This module contains all necessary modules
IMPLICIT NONE
CHARACTER(LEN=11), PARAMETER :: filename = "compound.h5" ! File name
CHARACTER(LEN=8), PARAMETER :: dsetname = "Compound" ! Dataset name
INTEGER, PARAMETER :: dimsize = 6 ! Size of the dataset
INTEGER(HID_T) :: file_id ! File identifier
int main (void)
{
/*
* Data initialization.
*/
int i, j;
int data[NX][NY]; // buffer for data to write
for (j = 0; j < NX; j++)
{
for (i = 0; i < NY; i++)
public class H5Ex_D_Chunk {
private static String FILENAME = "H5Ex_D_Chunk.h5";
private static String DATASETNAME = "DS1";
private static final int DIM_X = 6;
private static final int DIM_Y = 8;
private static final int CHUNK_X = 4;
private static final int CHUNK_Y = 4;
private static final int RANK = 2;
private static final int NDIMS = 2;
History:
| Release | Change |
| 1.10.0 | Function introduced in this release. |
--- Last Modified: November 16, 2017 | 01:30 PM