From a1e8b8b62e8d4fdcf5b618a9e0bf4bdf45ffc3ec Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 23 Apr 1999 15:43:12 -0500 Subject: [svn-r1206] RM_H5R.html Corrected parameter and return types in function prototypes and parameter descriptions Deleted comments regarding unimplemented functionality in R1.0 which has since been implemented Cleaned up formatting of commands TOC at top of page References.html Corrected parameter and return types in function prototypes and in example code Deleted comments regarding unimplemented functionality in R1.0 which has since been implemented --- doc/html/RM_H5R.html | 32 ++++++++++++-------------------- doc/html/References.html | 21 ++++++++------------- 2 files changed, 20 insertions(+), 33 deletions(-) diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index b558e81..d138670 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -52,35 +52,30 @@ The Reference interface allows the user to create references to specific objects and data regions in an HDF5 file.

- -
+ + + -
-       + -       +
-NYI = Not yet implemented. -

-Note: The only type of reference implemented in this release -is an object reference pointing to a dataset. -

Name: H5Rcreate
Signature: -
herr_t H5Rcreate(href_t *ref, +
herr_t H5Rcreate(void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, @@ -98,12 +93,9 @@ is an object reference pointing to a dataset.

The parameter space_id identifies the region to be pointed to (for dataset region references). -

- Note: Only object references of type H5T_STD_REF_OBJ - pointing to entire datasets are implemented at this time.

Parameters:
-
href_t *ref +
void *ref
OUT: Reference created by the function call.
hid_t loc_id
IN: Location identifier used to locate the object being @@ -128,7 +120,7 @@ is an object reference pointing to a dataset.
Signature:
hid_t H5Rdereference(hid_t dataset, H5R_type_t ref_type, - href_t *ref + void *ref )
Purpose:
Opens the HDF5 object referenced. @@ -161,9 +153,9 @@ is an object reference pointing to a dataset.
Name: H5Rget_region   (Not yet implemented.)
Signature: -
hid_t H5Rget_region(hid_t dataset, +
H5S_t H5Rget_region(H5D_t dataset, H5R_type_t ref_type, - href_t *ref + void *ref )
Purpose:
Retrieves a dataspace with the specified region selected. @@ -184,7 +176,7 @@ is an object reference pointing to a dataset.
IN: Dataset containing reference object.
H5R_type_t ref_type,
IN: The reference type of ref. -
href_t *ref +
void *ref
IN: Reference to open.
Returns: diff --git a/doc/html/References.html b/doc/html/References.html index 24a26ee..e985f8d 100644 --- a/doc/html/References.html +++ b/doc/html/References.html @@ -158,7 +158,7 @@ H5I interface, have been implemented to support references. The H5I function is also useful outside the context of references.

-
herr_t H5Rcreate(href_t *reference, +
herr_t H5Rcreate(void *reference, hid_t loc_id, const char *name, H5R_type_t type, @@ -171,23 +171,20 @@ The H5I function is also useful outside the context of references. in the dataspace is the portion of the dataset which will be referred to.

- Currently only object references which point to - entire datasets can be created. -

hid_t H5Rdereference(hid_t dset, H5R_type_t rtype, - href_t *ref) + void *reference)
H5Rdereference opens the object referenced and returns an identifier for that object. - The parameter ref specifies a reference of + The parameter reference specifies a reference of type rtype that is stored in the dataset dset.

-

hid_t H5Rget_region(hid_t dataset, +
H5S_t H5Rget_region(H5D_t dataset, H5R_type_t type, - href_t *reference) + void *reference)
H5Rget_region creates a copy of dataspace of the dataset that is pointed to and defines a selection in the copy which is the location (or region) pointed to. @@ -195,8 +192,6 @@ The H5I function is also useful outside the context of references. type rtype that is stored in the dataset dset.

- This function is not yet implemented. -

H5I_type_t H5Iget_type(hid_t id)
Returns the type of object referred to by the @@ -245,8 +240,8 @@ of its raw data and write the dataset to the file. hid_t dataset1; hid_t datatype, dataspace; char buf[128]; - href_t link; - href_t data[10][10]; + hobj_ref_t link; + hobj_ref_t data[10][10]; int rank; size_t dimsf[2]; int i, j; @@ -272,7 +267,7 @@ of its raw data and write the dataset to the file. for(j=0; j<10; i++) { sprintf(buf,"/Group/Linked Set %d-%d",i,j); - if(H5Rcreate(&link,file1,buf,H5R_REF_OBJ,-1)>0) + if(H5Rcreate(&link,file1,buf,H5R_OBJECT,-1)>0) data[i][j]=link; } /* end for */ -- cgit v0.12