/*-------------------------------------------------------------------------
* Function: H5Iget_type
*
* Purpose: The public version of H5I_get_type(), obtains a group number
* (type) when given an ID. The ID need not be the ID of an
* object which currently exists because the group number is
* encoded as part of the ID.
*
* Return: Success: Group number (type)
*
* Failure: H5I_BADID, a negative value
*
* Programmer:
*
* Modifications:
* Robb Matzke, 1999-08-23
* Also fails if the ID has a valid group but no longer exists
* in the ID tables.
*-------------------------------------------------------------------------
*/
H5I_type_t
H5Iget_type(hid_t id)
{
H5I_type_t ret_value = H5I_BADID;
FUNC_ENTER_API(H5Iget_type, H5I_BADID);
H5TRACE1("It","i",id);
ret_value = H5I_get_type(id);
if (ret_value <= H5I_BADID || ret_value >= H5I_NGROUPS || NULL==H5I_object(id))
HGOTO_DONE(H5I_BADID);
done:
FUNC_LEAVE_API(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_info1
*
* Purpose: Gets general information about the file, including:
* 1. Get storage size for superblock extension if there is one.
* 2. Get the amount of btree and heap storage for entries
* in the SOHM table if there is one.
* 3. The amount of free space tracked in the file.
*
* Return: Success: non-negative on success
* Failure: Negative
*
* Programmer: Vailin Choi
* July 11, 2007
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fget_info1(hid_t obj_id, H5F_info1_t *finfo)
{
H5F_t *f; /* Top file in mount hierarchy */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "i*x", obj_id, finfo);
/* Check args */
if(!finfo)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no info struct")
/* For file IDs, get the file object directly */
/* (This prevents the H5G_loc() call from returning the file pointer for
* the top file in a mount hierarchy)
*/
if(H5I_get_type(obj_id) == H5I_FILE ) {
if(NULL == (f = (H5F_t *)H5I_object(obj_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file")
} /* end if */
else {
/*--------------------------------------------------------------------------
NAME
H5G_user_path_test
PURPOSE
Retrieve the user path for an ID
USAGE
herr_t H5G_user_path_test(obj_id, user_path, user_path_len)
hid_t obj_id; IN: ID to check
char *user_path; OUT: Pointer to buffer for User path
size_t *user_path_len; OUT: Size of user path
unsigned *obj_hidden; OUT: Whether object is hidden
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Retrieves the user path for an ID. A zero for the length is returned in
the case of no user path.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
DO NOT USE THIS FUNCTION FOR ANYTHING EXCEPT TESTING
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5G_user_path_test(hid_t obj_id, char *user_path, size_t *user_path_len, unsigned *obj_hidden)
{
void *obj_ptr; /* Pointer to object for ID */
H5G_entry_t *obj_ent; /* Pointer to symbol table entry for obj */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5G_user_path_test, FAIL)
/* Sanity check */
HDassert(user_path_len);
HDassert(obj_hidden);
/* Get pointer to object for ID */
if(NULL == (obj_ptr = H5I_object(obj_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get object for ID")
/* Get the symbol table entry */
switch(H5I_get_type(obj_id)) {
case H5I_GROUP:
obj_ent = H5G_entof((H5G_t *)obj_ptr);
break;
case H5I_DATASET:
obj_ent = H5D_entof((H5D_t *)obj_ptr);
break;
case H5I_DATATYPE:
/* Avoid non-named datatypes */
if(!H5T_is_named((H5T_t *)obj_ptr))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a named datatype")
obj_ent = H5T_entof((H5T_t *)obj_ptr);
break;
default:
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "unknown data object type")
} /* end switch */
HDassert(obj_ent);
/* Retrieve a copy of the user path and put it into the buffer */
if(obj_ent->user_path_r) {
size_t len = H5RS_len(obj_ent->user_path_r);
/* Set the user path, if given */
if(user_path)
HDstrcpy(user_path, H5RS_get_str(obj_ent->user_path_r));
/* Set the length of the path */
*user_path_len = len;
/* Set the user path hidden flag */
*obj_hidden = obj_ent->obj_hidden;
} /* end if */
else {
*user_path_len = 0;
*obj_hidden = 0;
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5G_user_path_test() */
