.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "MPI_INFO_GET_STRING" "3" "May 13, 2024" "" "Open MPI" .sp \fI\%MPI_Info_get_string\fP — Retrieves the value associated with a key in an info object. .SH SYNTAX .SS C Syntax .INDENT 0.0 .INDENT 3.5 .sp .EX #include int MPI_Info_get_string(MPI_Info info, const char *key, int *buflen, char *value, int *flag) .EE .UNINDENT .UNINDENT .SS Fortran Syntax .INDENT 0.0 .INDENT 3.5 .sp .EX USE MPI ! or the older form: INCLUDE \(aqmpif.h\(aq MPI_INFO_GET_STRING(INFO, KEY, BUFLEN, VALUE, FLAG, IERROR) INTEGER INFO, BUFLEN, IERROR CHARACTER*(*) KEY, VALUE LOGICAL FLAG .EE .UNINDENT .UNINDENT .SS Fortran 2008 Syntax .INDENT 0.0 .INDENT 3.5 .sp .EX USE mpi_f08 MPI_Info_get_string(info, key, buflen, value, flag, ierror) TYPE(MPI_Info), INTENT(IN) :: info CHARACTER(LEN=*), INTENT(IN) :: key INTEGER, INTENT(INOUT) :: buflen CHARACTER(LEN=valuelen), INTENT(OUT) :: value LOGICAL, INTENT(OUT) :: flag INTEGER, OPTIONAL, INTENT(OUT) :: ierror .EE .UNINDENT .UNINDENT .SH INPUT PARAMETERS .INDENT 0.0 .IP \(bu 2 \fBinfo\fP: Info object (handle). .IP \(bu 2 \fBkey\fP: Key (string). .UNINDENT .SH OUTPUT PARAMETER .INDENT 0.0 .IP \(bu 2 \fBbuflen On entry, length of value arg. On return, set to required size to\fP: hold value string (integer). .IP \(bu 2 \fBvalue\fP: Value (string). .IP \(bu 2 \fBflag\fP: Returns true if key defined, false if not (boolean). .IP \(bu 2 \fBierror\fP: Fortran only: Error status (integer). .UNINDENT .SH DESCRIPTION .sp \fI\%MPI_Info_get_string\fP retrieves the value associated with \fIkey\fP from \fIinfo\fP, if any. If such a key exists in info, it sets \fIflag\fP to true and returns the value in \fIvalue\fP, otherwise it sets flag to false and leaves value unchanged. \fIbuflen\fP on input is the size of the provided buffer, for the output of buflen it is the size of the buffer needed to store the value string. If the buflen passed into the function is less than the actual size needed to store the value string (including null terminator in C), the value is truncated. On return, the value of \fIbuflen\fP will be set to the required buffer size to hold the value string. If buflen is set to 0, value is not changed. In C, \fIbuflen\fP includes the required space for the null terminator. In C, this function returns a null terminated string in all cases where the \fIbuflen\fP input value is greater than 0. .sp If \fIkey\fP is larger than MPI_MAX_INFO_KEY, the call is erroneous. .SH ERRORS .sp Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument. .sp Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before \fI\%MPI_Init\fP/\fI\%MPI_Init_thread\fP, after \fI\%MPI_Finalize\fP, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling \fI\%MPI_Comm_set_errhandler\fP on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to \fI\%MPI_Comm_spawn\fP/\fI\%MPI_Comm_spawn_multiple\fP\&. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. .sp Open MPI includes three predefined error handlers that can be used: .INDENT 0.0 .IP \(bu 2 \fBMPI_ERRORS_ARE_FATAL\fP Causes the program to abort all connected MPI processes. .IP \(bu 2 \fBMPI_ERRORS_ABORT\fP An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if \fI\%MPI_Abort\fP was called on that communicator. If called on a window or file, acts as if \fI\%MPI_Abort\fP was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process. .IP \(bu 2 \fBMPI_ERRORS_RETURN\fP Returns an error code to the application. .UNINDENT .sp MPI applications can also implement their own error handlers by calling: .INDENT 0.0 .IP \(bu 2 \fI\%MPI_Comm_create_errhandler\fP then \fI\%MPI_Comm_set_errhandler\fP .IP \(bu 2 \fI\%MPI_File_create_errhandler\fP then \fI\%MPI_File_set_errhandler\fP .IP \(bu 2 \fI\%MPI_Session_create_errhandler\fP then \fI\%MPI_Session_set_errhandler\fP or at \fI\%MPI_Session_init\fP .IP \(bu 2 \fI\%MPI_Win_create_errhandler\fP then \fI\%MPI_Win_set_errhandler\fP .UNINDENT .sp Note that MPI does not guarantee that an MPI program can continue past an error. .sp See the \fI\%MPI man page\fP for a full list of \fI\%MPI error codes\fP\&. .sp See the Error Handling section of the MPI\-3.1 standard for more information. .sp \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP \(bu 2 \fI\%MPI_Info_create\fP .IP \(bu 2 \fI\%MPI_Info_delete\fP .IP \(bu 2 \fI\%MPI_Info_dup\fP .IP \(bu 2 \fI\%MPI_Info_free\fP .IP \(bu 2 \fI\%MPI_Info_get_nkeys\fP .IP \(bu 2 \fI\%MPI_Info_get_nthkey\fP .IP \(bu 2 \fI\%MPI_Info_set\fP .UNINDENT .UNINDENT .UNINDENT .SH COPYRIGHT 2003-2024, The Open MPI Community .\" Generated by docutils manpage writer. .