mpiAxisConfigGet

Declaration

int32_t mpiAxisConfigGet(MPIAxis       axis,
                      MPIAxisConfig *config;

Required Header: axis.h

Change History: Modified in 04.00. Modified in 03.03.00.

Description

mpiAxisConfigGet gets the configuration of an Axis (axis) and writes it into the structure pointed to by config.

axis
a handle to an Axis object.
*config
pointer to the MPIAxisConfig structure
Return Values
MPIMessageOK

Sample Code

    /* Configure axis */
    returnValue =
        mpiAxisConfigGet(axis, &axisConfig);

    axisConfig.settle.tolerance.distance = 50.0;
    axisConfig.settle.tolerance.speed    = 100.0;
    axisConfig.settle.time               = .1;	/* seconds */

     if (returnValue == MPIMessageOK) {
        mpiAxisConfigSet(axis, &axisConfig);	
     }

See Also

MPIAxisConfig | mpiAxisConfigSet | MPIAxisConfig