mpi_info_get_nkeys(3openmpi) [osx man page]

MPI_Info_get_nkeys(3OpenMPI)											      MPI_Info_get_nkeys(3OpenMPI)

NAME

       MPI_Info_get_nkeys - Gets the number of keys currently defined in an info object.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Info_get_nkeys(MPI_Info info, int *nkeys)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_INFO_GET_NKEYS(INFO, NKEYS, IERROR)
	    INTEGER	   INFO, NKEYS, IERROR

C++ Syntax
       #include <mpi.h>
       int MPI::Info::Get_nkeys() const

INPUT PARAMETER

       info	 Info object (handle).

OUTPUT PARAMETERS

       nkeys	 Number of defined keys (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Info_get_nkeys returns the number of currently defined keys in info.

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_nthkey
       MPI_Info_get_valueln

Open MPI 1.2							  September 2006				      MPI_Info_get_nkeys(3OpenMPI)

MPI_Info_get_nkeys(3)						      LAM/MPI						     MPI_Info_get_nkeys(3)

NAME

       MPI_Info_get_nkeys -  Returns the number of keys defined on an MPI_Info object

SYNOPSIS

       #include <mpi.h>
       int MPI_Info_get_nkeys(MPI_Info info, int *nkeys)

INPUT PARAMETER

       info   - info object (handle)

OUTPUT PARAMETER

       nkeys  - number of keys defined on info (integer)

NOTES FOR FORTRAN

       All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list.  ierr
       is an integer and has the same meaning as the return value of the routine in C.	In Fortran, MPI routines are subroutines, and are  invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       If an error occurs in an MPI function, the current MPI error handler is called to handle it.  By default, this error handler aborts the MPI
       job.  The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause  error
       values  to  be  returned  (in  C and Fortran; this error handler is less useful in with the C++ MPI bindings.  The predefined error handler
       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered).  Note that MPI does not guarantee that an MPI
       program can continue past an error.

       All  MPI  routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in
       the last argument.  The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing  exceptions	of
       type MPI::Exception (but not by default).  Exceptions are only thrown if the error value is not MPI::SUCCESS
	.

       Note  that  if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover
       what the actual error value was.
       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class.  This is typically a NULL pointer	or
	      other such error.

MORE INFORMATION

       For  more  information,	please	see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards.  These
       documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

LOCATION

       infogetnkeys.c

LAM
/MPI 6.5.8							    11/10/2002						     MPI_Info_get_nkeys(3)