[svn-r13347] Description:

Deprecate H5Adelete in favor of H5Adelete2, which corresponds to the new
pattern of specifying an object's location.

Tested on:
    Linux/32 2.6 (chicago)
    Linux/64 2.6 (chicago2)
This commit is contained in:
Quincey Koziol 2007-02-20 11:00:24 -05:00
parent 19257978d9
commit 4486398a98
4 changed files with 94 additions and 28 deletions

View File

@ -1642,43 +1642,67 @@ done:
/*--------------------------------------------------------------------------
NAME
H5Adelete
H5Adelete2
PURPOSE
Deletes an attribute from a location
USAGE
herr_t H5Adelete (loc_id, name)
hid_t loc_id; IN: Object (dataset or group) to have attribute deleted from
const char *name; IN: Name of attribute to delete
hid_t loc_id; IN: Base location for object
const char *obj_name; IN: Name of object relative to location
const char *attr_name; IN: Name of attribute to delete
hid_t lapl_id; IN: Link access property list
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function removes the named attribute from a dataset or group.
This function should not be used when attribute IDs are open on 'loc_id'
as it may cause the internal indexes of the attributes to change and future
writes to the open attributes to produce incorrect results.
This function removes the named attribute from an object.
--------------------------------------------------------------------------*/
herr_t
H5Adelete(hid_t loc_id, const char *name)
H5Adelete2(hid_t loc_id, const char *obj_name, const char *attr_name,
hid_t lapl_id)
{
H5G_loc_t loc; /* Object location */
H5G_loc_t obj_loc; /* Location used to open group */
H5G_name_t obj_path; /* Opened object group hier. path */
H5O_loc_t obj_oloc; /* Opened object object location */
hbool_t loc_found = FALSE; /* Entry at 'obj_name' found */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Adelete, FAIL)
H5TRACE2("e", "is", loc_id, name);
FUNC_ENTER_API(H5Adelete2, FAIL)
/* check arguments */
if(H5I_ATTR == H5I_get_type(loc_id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "location is not valid for an attribute")
if(H5G_loc(loc_id, &loc) < 0)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location")
if(!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name")
if(!obj_name || !*obj_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no object name")
if(!attr_name || !*attr_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no attribute name")
if(H5P_DEFAULT == lapl_id)
lapl_id = H5P_LINK_ACCESS_DEFAULT;
else
if(TRUE != H5P_isa_class(lapl_id, H5P_LINK_ACCESS))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not link access property list ID")
/* Set up opened group location to fill in */
obj_loc.oloc = &obj_oloc;
obj_loc.path = &obj_path;
H5G_loc_reset(&obj_loc);
/* Find the object's location */
if(H5G_loc_find(&loc, obj_name, &obj_loc/*out*/, lapl_id, H5AC_ind_dxpl_id) < 0)
HGOTO_ERROR(H5E_ATTR, H5E_NOTFOUND, FAIL, "object not found")
loc_found = TRUE;
/* Delete the attribute from the location */
if(H5O_attr_remove(loc.oloc, name, H5AC_dxpl_id) < 0)
if(H5O_attr_remove(obj_loc.oloc, attr_name, H5AC_dxpl_id) < 0)
HGOTO_ERROR(H5E_ATTR, H5E_CANTDELETE, FAIL, "unable to delete attribute")
done:
/* Release resources */
if(loc_found && H5G_loc_free(&obj_loc) < 0)
HDONE_ERROR(H5E_ATTR, H5E_CANTRELEASE, FAIL, "can't free location")
FUNC_LEAVE_API(ret_value)
} /* H5Adelete() */

View File

@ -165,3 +165,43 @@ done:
FUNC_LEAVE_API(ret_value)
} /* H5Aget_num_attrs() */
/*--------------------------------------------------------------------------
NAME
H5Adelete
PURPOSE
Deletes an attribute from a location
USAGE
herr_t H5Adelete (loc_id, name)
hid_t loc_id; IN: Object (dataset or group) to have attribute deleted from
const char *name; IN: Name of attribute to delete
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function removes the named attribute from a dataset or group.
--------------------------------------------------------------------------*/
herr_t
H5Adelete(hid_t loc_id, const char *name)
{
H5G_loc_t loc; /* Object location */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Adelete, FAIL)
H5TRACE2("e", "is", loc_id, name);
/* check arguments */
if(H5I_ATTR == H5I_get_type(loc_id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "location is not valid for an attribute")
if(H5G_loc(loc_id, &loc) < 0)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location")
if(!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name")
/* Delete the attribute from the location */
if(H5O_attr_remove(loc.oloc, name, H5AC_dxpl_id) < 0)
HGOTO_ERROR(H5E_ATTR, H5E_CANTDELETE, FAIL, "unable to delete attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* H5Adelete() */

View File

@ -64,7 +64,8 @@ H5_DLL ssize_t H5Aget_name_by_idx(hid_t loc_id, const char *obj_name,
H5_DLL herr_t H5Arename(hid_t loc_id, const char *old_name, const char *new_name);
H5_DLL herr_t H5Aiterate(hid_t loc_id, unsigned *attr_num, H5A_operator_t op,
void *op_data);
H5_DLL herr_t H5Adelete(hid_t loc_id, const char *name);
H5_DLL herr_t H5Adelete2(hid_t loc_id, const char *obj_name,
const char *attr_name, hid_t lapl_id);
H5_DLL herr_t H5Adelete_by_idx(hid_t loc_id, const char *obj_name,
H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id);
@ -74,6 +75,7 @@ H5_DLL herr_t H5Adelete_by_idx(hid_t loc_id, const char *obj_name,
* Use of these functions and variables is deprecated.
*/
H5_DLL int H5Aget_num_attrs(hid_t loc_id);
H5_DLL herr_t H5Adelete(hid_t loc_id, const char *name);
#ifdef __cplusplus
}

View File

@ -3386,8 +3386,8 @@ test_attr_corder_transition(hid_t fcpl, hid_t fapl)
/* Delete several attributes from object, until attribute storage resumes compact form */
for(u = max_compact; u >= min_dense; u--) {
sprintf(attrname, "attr %02u", u);
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
/* Verify state of object */
ret = H5O_num_attrs_test(my_dataset, &nattrs);
@ -3406,8 +3406,8 @@ test_attr_corder_transition(hid_t fcpl, hid_t fapl)
/* Delete another attribute, to push attribute storage into compact form */
sprintf(attrname, "attr %02u", (min_dense - 1));
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
/* Verify state of object */
ret = H5O_num_attrs_test(my_dataset, &nattrs);
@ -3510,8 +3510,8 @@ test_attr_corder_transition(hid_t fcpl, hid_t fapl)
/* Delete several attributes from object, until attribute storage resumes compact form */
for(u = max_compact; u >= min_dense; u--) {
sprintf(attrname, "attr %02u", u);
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
/* Verify state of object */
ret = H5O_num_attrs_test(my_dataset, &nattrs);
@ -3530,8 +3530,8 @@ test_attr_corder_transition(hid_t fcpl, hid_t fapl)
/* Delete another attribute, to push attribute storage into compact form */
sprintf(attrname, "attr %02u", (min_dense - 1));
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
/* Verify state of object */
ret = H5O_num_attrs_test(my_dataset, &nattrs);
@ -3575,12 +3575,12 @@ test_attr_corder_transition(hid_t fcpl, hid_t fapl)
/* Delete all attributes */
for(u = max_compact; u > 0; u--) {
sprintf(attrname, "attr %02u", u);
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
} /* end for */
sprintf(attrname, "attr %02u", 0);
ret = H5Adelete(my_dataset, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(my_dataset, ".", attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
} /* end for */
/* Close Datasets */
@ -5599,8 +5599,8 @@ test_attr_shared_delete(hid_t fcpl, hid_t fapl)
sprintf(attrname, "attr %02u", u);
/* Delete second dataset's attribute */
ret = H5Adelete(dataset2, attrname);
CHECK(ret, FAIL, "H5Adelete");
ret = H5Adelete2(fid, DSET2_NAME, attrname, H5P_DEFAULT);
CHECK(ret, FAIL, "H5Adelete2");
/* Check refcount on attributes now */