Inquire meta-data associated with a dimension.
More...
Inquire meta-data associated with a dimension.
This API can be used to inquire the meta-data associated with a dimension in a file. The user can query the name & length of a dimension using the id of the dimension.
This API is a collective call (Although the library might internally choose to make progress on a single or small subset of MPI processes) on the I/O system associated with the file
◆ pio_inquire_dimension_fh_offlen()
integer function spio_inq_dim::pio_inquire_dimension_fh_offlen |
( |
integer, intent(in) |
fh, |
|
|
integer, intent(in) |
dimid, |
|
|
character(len=*), intent(out), optional |
name, |
|
|
integer(pio_offset_kind), intent(out), optional |
len |
|
) |
| |
Inquire the meta-data associated with a dimension in a file.
- Parameters
-
[in] | fh | The file id/handle |
[in] | dimid | The id of the dimension |
[out] | name | (Optional) The dimension name |
[out] | len | (Optional) The length (KIND=PIO_OFFSET_KIND) of the dimension |
- Return values
-
ierr | : The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling) |
◆ pio_inquire_dimension_file()
integer function spio_inq_dim::pio_inquire_dimension_file |
( |
type(file_desc_t), intent(in) |
file, |
|
|
integer, intent(in) |
dimid, |
|
|
character(len=*), intent(out), optional |
name, |
|
|
integer, intent(out), optional |
len |
|
) |
| |
Inquire the meta-data associated with a dimension in a file.
- Parameters
-
[in] | file | The file handle. File descriptor structure. This structure holds information associated with each open file |
[in] | dimid | The id of the dimension |
[out] | name | (Optional) The dimension name |
[out] | len | (Optional) The length of the dimension |
- Return values
-
ierr | : The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling) |