Query scope open status¶
ss_scope_isopen
is a function defined in ssscope.c.
Synopsis:
-
hid_t
ss_scope_isopen
(ss_scope_t *scope)¶
Formal Arguments:
scope
: A link to a scope object.
Description: A scope is either opened or closed at any given time on any given task. This function returns that status.
Return Value: Returns true (a positive HDF5 group handle) if scope
is currently opened by the calling task; false if scope
is currently closed; negative on error. The group handle is not duplicated and the caller should not invoke
H5Gclose
on the return value. This function returns an error (instead of false) if the scope is not even
booted. To be “booted” means the scope object corresponds to some HDF5 group which is open.
Parallel Notes: Independent
Issues: The group handle return value is not duplicated by this function because (1) not doing so is consistent with ss_file_isopen and (2) doing so would require this function to be collective.
Since transient files are not supported by HDF5 there can be no HDF5 file handle for a scope created in a transient file. This function returns the integer 1 for such files, which is a positive true value but which is not a valid HDF5 group handle (or any valid handle for that matter).
See Also:
- ss_file_isopen: 11.5: Test file open status
- Scopes: Introduction for current chapter