.

mpiAxisFlashOriginGet

Declaration

  
long mpiAxisFlashOriginGet(MPIAxis   axis,
                           void      *flash,
                           double    *origin)
  
Required Header: stdmpi.h
Change History: Added in the 03.04.00

Description

mpiAxisFlashOriginGet reads the flash value of the origin for an Axis and writes it into the location pointed to by origin. The flash origin value is useful for applying an offset value to the controller’s actual position with absolute feedback devices.

 
axis a handle to the Axis object.
*flash

flash is either an MEIFlash handle or MPIHandleVOID.

If flash is MPIHandleVOID, an MEIFlash object will be created and deleted internally. Using MPIHandleVOID is recommended, as it simplifies code.

If flash is a valid MEIFlash handle, then the MEIFlash object cache will be updated, but the actual write to controller flash will not occur. Use meiFlashMemoryFromFileType(...) to prompt the actual write to flash.
*origin pointer to the Origin value returned by the method.
   
 
Return Values  
MPIMessageOK  

See Also

mpiAxisFlashOriginSet | mpiAxisOriginGet | Using the Origin Variable | Controller Positions

 
       Legal Notice  |  Tech Email  |  Feedback
       Copyright © 2001-2021 Motion Engineering