mpiUserLimitEnableGet
Declaration
MPI_DECL1 MPI_RESULT MPI_DECL2 mpiUserLimitEnableGet(MPIUserLimit userLimit, MPI_BOOL *enabled);
Required Header: stdmpi.h
Change History: Added in 04.00.
Description
mpiUserLimitEnableGet gets the enable state of the user limit object (userLimit) and writes it in the location pointed to by enabled.
| userLimit | The handle to the user limit object. |
|---|---|
| enabled | A pointer to the location where the enable state is written. If the user limit is enabled, *enabled will be set to TRUE. If the user limit is disabled, *enabled is set to FALSE. |
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;
}