SCORPIO  1.7.0
Functions/Subroutines
PIO_enddef

End the "define" mode of the file. More...

Functions/Subroutines

integer function spio_def_file::pio_enddef_fh (fh)
 End/Exit the "define" mode of a file. More...
 
integer function spio_def_file::pio_enddef_file (file)
 End/Exit the "define" mode of a file. More...
 

Detailed Description

End the "define" mode of the file.

This API can be used to end the "define" mode for a file. The define mode is a setting for the file to define the meta-data associated with the data in the file (define the variables, dimensions, attributes etc). A file enters the "define" mode when its created or explicitly using the PIO_redef call. The user needs to end/exit the "define" mode to start writing data to the file.

The meta-data specified during the "define" mode is typically stored in the output file header section.

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

Function/Subroutine Documentation

◆ pio_enddef_fh()

integer function spio_def_file::pio_enddef_fh ( integer, intent(in)  fh)

End/Exit the "define" mode of a file.

Parameters
[in]fhThe file id/handle.
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_enddef_file()

integer function spio_def_file::pio_enddef_file ( type(file_desc_t), intent(in)  file)

End/Exit the "define" mode of a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
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)