mpiUserLimitEnableSet

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiUserLimitEnableSet(MPIUserLimit    userLimit,
                         MPI_BOOL        enable);

 

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiUserLimitEnableSet sets the enable state of the user limit object (userLimit) to enable.

userLimit The handle to the user limit object.
enable The new enable state of the usre limit object.

If enable is TRUE, then the user limit is enabled

If enable is FALSE, then the user limit is disabled.

Sample Code

MPIUserLimit createDisabledUserLimit(MPIControl control, int32_t number)
    {
        MPI_RESULT         returnValue;
        MPIUserLimit       userLimit = MPIHandleVOID;

        /* Create user limit */

        returnValue = mpiUserLimitCreate(&userLimit, control, number);

        msgCHECK(returnValue);

        /* Disable user limit in case the user limit was enabled */

        returnValue = mpiUserLimitEnableSet(userLimit, FALSE);

        if (returnValue != MPIMessageOK)
             {
                  /* Free resources in case anything went wrong */
                  mpiUserLimitDelete(userLimit);
                  msgCHECK(returnValue);
             }
        return userLimit;
    }

See Also

mpiUserLimitEnableGet