mpiUserLimitConfigGet

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiUserLimitConfigGet(MPIUserLimit         userLimit,
                         MPIUserLimitConfig*  config);

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

Description

mpiUserLimitConfigGet gets a user limit's configuration and writes it into the structure pointed to by config.

mpiUserLimitConfigGet completes the custom member of the user limit’s condition and output blocks (represented by MPIUserLimitConditionCustom and MPIUserLimitOutputCustom). This provides applications how to write the block as a custom block.

Recommendation:
Use mpiUserLimitConfigDefault to initialize the MPIUserLimitConfig data structure when setting a new configuration where most parameters need to be set. Use mpiUserLimitGet to initialize the MPIUserLimitConfig data structure when the existing configuration on the controller is similar to the new configuration and change only a the required parameters.

userLimit	The user limit handle.
config	A pointer to the configuration structure where the configuration information is to be written.

Sample Code

MPI_BOOL doesUserLimitGenerateEvent(MPIUserLimit userLimit)
   {
        MPI_RESULT                  returnValue;
        MPIUserLimitConfig          config;

        returnValue = mpiUserLimitConfigGet(userLimit, &config);

        msgCHECK(returnValue);

        return config.generateEvent;
    }

mpiUserLimitConfigGet

Declaration

Description

Sample Code

See Also