Open MPI logo

MPI_Unpublish_name(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_Unpublish_name - Unpublishes a service name

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Unpublish_name(char *service_name, MPI_Info info,
            char *port_name)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_UNPUBLISH_NAME(SERVICE_NAME, INFO, PORT_NAME, IERROR)
            CHARACTER*(*)  SERVICE_NAME, PORT_NAME
            INTEGER        INFO, IERROR

C++ Syntax

       #include <mpi.h>
       void MPI::Unpublish_name(const char* service_name, const MPI::Info& info,
            char* port_name)

INPUT PARAMETERS

       service_name  A service name (string).

       info          Options  to  the  name  service  functions  (handle).  No
                     options currently supported.

       port_name     A port name (string).

OUTPUT PARAMETER

       IERROR        Fortran only: Error status (integer).

DESCRIPTION

       This routine removes the pair (service_name, port_name) so that  appli-
       cations may no longer retrieve port_name by calling MPI_Lookup_name. It
       is an error to unpublish a service_name  that  was  not  published  via
       MPI_Publish_name.  Both  the  service_name  and  port_name arguments to
       MPI_Unpublish_name must be identical to the arguments to  the  previous
       call to MPI_Publish_name.

       The  info  parameter  should be MPI_INFO_NULL, as this routine does not
       parse any MPI Info arguments.

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

SEE ALSO

       MPI_Publish_name
       MPI_Lookup_name
       MPI_Open_port

Open MPI 1.2                      March 2007      MPI_Unpublish_name(3OpenMPI)

« Return to documentation listing