Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_info_get_valuelen(3openmpi) [osx man page]

MPI_Info_get_valuelen(3OpenMPI) 										   MPI_Info_get_valuelen(3OpenMPI)

NAME

       MPI_Info_get_valuelen - Retrieves the length of the key value associated with an info object.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Info_get_valuelen(MPI_Info info, char *key,
	    int *valuelen, int *flag)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_INFO_GET_VALUELEN(INFO, KEY, VALUELEN, FLAG, IERROR)
	    INTEGER	   INFO, VALUELEN, IERROR
	    LOGICAL	   FLAG
	    CHARACTER*(*)  KEY

C++ Syntax
       #include <mpi.h>
       bool MPI::Info::Get_valuelen(const char* key, int& valuelen)
	    const

INPUT PARAMETERS

       info	 Info object (handle).

       key	 Key (string).

OUTPUT PARAMETERS

       valuelen  Length of value arg (integer).

       flag	 Returns true if key defined, false if not (boolean).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Info_get_valuelen  retrieves the length of the value associated with key. If key is defined, valuelen is set to the length of its asso-
       ciated value and flag is set to true. If key is not defined, valuelen is not touched and flag is set to false. The length returned in C	or
       C++ does not include the end-of-string character.

       If key is larger than MPI_MAX_INFO_KEY, the call is erroneous.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN  may	be
       used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

SEE ALSO

       MPI_Info_get
       MPI_Info_get_nkeys
       MPI_Info_get_nthkey

Open MPI 1.2							  September 2006				   MPI_Info_get_valuelen(3OpenMPI)

Check Out this Related Man Page

MPI_Info_set(3OpenMPI)													    MPI_Info_set(3OpenMPI)

NAME

       MPI_Info_set - Adds a key/value pair to info.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Info_set(MPI_Info info, char *key, char *value)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_INFO_SET(INFO, KEY, VALUE, IERROR)
	    INTEGER	   INFO, IERROR
	    CHARACTER*(*)  KEY, VALUE

C++ Syntax
       #include <mpi.h>
       void MPI::Info::Set(const char* key, const char* value)

INPUT
/OUTPUT PARAMETER
       info	 Info object (handle).

INPUT PARAMETERS

       key	 Key (string).

       value	 Value (string).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Info_set  adds  the	(key,value) pair to info and overrides the value if a value for the same key was previously set. The key and value
       parameters are null-terminated strings in C. In Fortran, leading and trailing spaces in key and value are stripped. If either key or  value
       is larger than the allowed maximums, the error MPI_ERR_INFO_KEY or MPI_ERR_INFO_VALUE is raised, respectively.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN  may	be
       used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

SEE ALSO

       MPI_Info_create
       MPI_Info_delete
       MPI_Info_dup
       MPI_Info_free
       MPI_Info_set

Open MPI 1.2							  September 2006					    MPI_Info_set(3OpenMPI)
Man Page