MPIWincreatekeyval(3OpenMPI) MPIWincreatekeyval(3OpenMPI)

NAME
       MMPPIIWWiinnccrreeaatteekkeeyyvvaall -


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIWincreatekeyval(MPIWincopyattrfunction *wincopyattrfn,
            MPIWindeleteattrfunction *windeleteattrfn,
            int *winkeyval, void *extrastate)


FFoorrttrraann SSyynnttaaxx ((sseeee FFOORRTTRRAANN 7777 NNOOTTEESS))
       INCLUDE 'mpif.h'
       MPIWINCREATEKEYVAL(WINCOPYATTRFN, WINDELETEATTRFN,
            WINKEYVAL, EXTRASTATE, IERROR)
            EXTERNAL WINCOPYATTRFN, WINDELETEATTRFN
            INTEGER WINKEYVAL, IERROR
            INTEGER(KIND=MPIADDRESSKIND) EXTRASTATE


CC++++ SSyynnttaaxx
       #include 
       static int MPI::Win::Createkeyval(MPI::Win::Copyattrfunction*
            wincopyattrfn,
            MPI::Win::Deleteattrfunction* windeleteattrfn,
            void* extrastate)


IINNPPUUTT PPAARRAAMMEETTEERRSS
       wincopyattrfn
                 Copy callback function for winkeyval (function).

       windeleteattrfn
                 Delete callback function for winkeyval (function).

       extrastate
                 Extra state for callback functions.


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       winkeyval
                 Key value for future access (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The  argument wincopyattrfn may be specified as MPIWINNULLCOPYFN
       or MPIWINDUPFN from either C, C++, or Fortran.  MPIWINNULLCOPYFN
       is  a  function  that  serves  only to return flag = 0 and MPISUCCESS.
       MPIWINDUPFN is a simple-minded copy function that  sets  flag  =  1,
       returns the value of attributevalin in attributevalout, and returns
       MPISUCCESS.

       The    argument    windeleteattrfn    may    be     specified     as
       MPIWINNULLDELETEFN    from    either    C,    C++,    or   Fortran.
       MPIWINNULLDELETEFN  is  a  function  that  serves  only  to  return
       MPISUCCESS.

       The C callback functions are:

       typedef int MPIWincopyattrfunction(MPIWin oldwin, int winkeyval,
                    void *extrastate, void *attributevalin,
                    void *attributevalout, int *flag);

       and

       typedef int MPIWindeleteattrfunction(MPIWin win, int winkeyval,
                    void *attributeval, void *extrastate);

       The Fortran callback functions are:

       SUBROUTINE WINCOPYATTRFN(OLDWIN, WINKEYVAL, EXTRASTATE,
            ATTRIBUTEVALIN, ATTRIBUTEVALOUT, FLAG, IERROR)
            INTEGER OLDWIN, WINKEYVAL, IERROR
            INTEGER(KIND=MPIADDRESSKIND) EXTRASTATE, ATTRIBUTEVALIN,
                 ATTRIBUTEVALOUT
            LOGICAL FLAG

       and

       SUBROUTINE WINDELETEATTRFN(WIN, WINKEYVAL, ATTRIBUTEVAL,
            EXTRASTATE, IERROR)
            INTEGER WIN, WINKEYVAL, IERROR
            INTEGER(KIND=MPIADDRESSKIND) ATTRIBUTEVAL, EXTRASTATE

       The C++ callbacks are:

       typedef int MPI::Win::Copyattrfunction(const MPI::Win& oldwin,
            int winkeyval, void* extrastate, void* attributevalin,
            void* attributevalout, bool& flag);

       and

       typedef int MPI::Win::Deleteattrfunction(MPI::Win& win, int winkeyval, void* attributeval, void* extrastate);


FFOORRTTRRAANN 7777 NNOOTTEESS
       The MPI standard prescribes portable Fortran syntax for the EXTRASTATE
       argument only for Fortran 90. FORTRAN 77 users may use the non-portable
       syntax

            INTEGER*MPIADDRESSKIND EXTRASTATE

       where  MPIADDRESSKIND  is  a constant defined in mpif.h and gives the
       length of the declared integer in bytes.


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.




Open MPI 1.2                    September 2006 MPIWincreatekeyval(3OpenMPI)