mpiUserLimitValidate

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiUserLimitValidate(MPIUserLimit userLimit);

 

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

Description

mpiUserLimitValidate validates the user limit object and its handle (userLimit). mpiUserLimitValidate should be called immediately after an object is created.

userLimit The user limit handle to validate.
MPI_BOOL isUserLimitEnabled(MPIUserLimit userLimit)
    {
        MPI_RESULT  returnValue;
        MPI_BOOL    enabled = FALSE;

        /* Make sure we have a valid handle */

        returnValue = mpiUserLimitValidate(userLimit);

        msgCHECK(returnValue);

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

        returnValue = mpiUserLimitEnableGet(userLimit, &enabled);

        msgCHECK(returnValue);

        return enabled;
	}

See Also

mpiUserLimitCreate