mpiMotionParamsGet

Declaration

	long mpiMotionParamsGet(MPIMotion motion, MPIMotionParams *params)
	Required Header: stdmpi.h

Description

mpiMotionParamsGet reads the parameters of a Motion object (motion) and writes it to the structure pointed to by params. These motion parameters will be used if mpiMotionStart(...) is called with Null motion params.

motion	a handle to the Motion object.
*params	a pointer to the motion parameters structure returned by the method.

Return Values
MPIMessageOK
motion parameters	that are associated with a Motion object (motion). To set these motion parameters, call either mpiMotionParamsSet(...) or mpiMotionStart(...)