mpiMotionFlashConfigGet

Declaration

	long mpiMotionFlashConfigGet(MPIMotion motion, void flash, MPIMotionConfig config, void *external)
	Required Header: stdmpi.h

Description

mpiMotionFlashConfigGet gets the flash configuration for a Motion object (motion) and puts (writes) it into the structure pointed to by config, and also writes it into the implementation-specific structure pointed to by external (if external is not NULL).

The Motion's flash configuration information in external is in addition to the Motion's flash configuration information in config, i.e., the flash configuration information in config and in external is not the same information. Note that config or external can be NULL (but not both NULL). The implementation-specific flash argument is used to access flash memory.

Remarks

external either points to a structure of type MEIMotionConfig{} or is NULL. flash is either an MEIFlash handle or MPIHandleVOID. If flash is MPIHandleVOID, an MEIFlash object will be created and deleted internally.

motion	a handle to a Motion 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.
*config	a pointer to a configuration structure for the motion object of type MPIMotionConfig.
*external	a pointer to a configuration structure for the motion object of type MEIMotionConfig.

Return Values
MPIMessageOK