mpiUserLimitDelete

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
	mpiUserLimitDelete(MPIUserLimit userLimit);

 

Required Header: stdmpi.h
Change History: Added in 04.00.

Description

mpiUserLimitDelete deletes a user limit object and invalidates its handle (userLimit). mpiUserLimitDelete is the equivalent of a C++ destructor.

userLimit The user limit handle to delete.

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

mpiUserLimitCreate