TextFileWritePrintf

Write ordered output to a file, using printf-style

Synopsis

int TextFileWritePrintf(TextFile fh, const char *restrict format, ...)

Input Parameters

fh
TextFile previously opened
format
printf style format
...
Parameters for the format.

Notes

This routine writes to the file (or FILE handle) previously opened. The output is ordered with respect to the rank in the communicator associated with the TextFile. The output is buffered in this routine; a collective call to TextFileWriteFlush is requried to ensure that the data is output. The usage is nearly identical to fprintf; the only difference is that instead of a FILE as the first parameter, a TextFile must be provided.

Return value

An error code. Currently, MPI_SUCCESS is returned on success and an MPI error class is returned on failure. A future implementation may return a user-defined MPI error code.