mpiAxisFlashConfigGet

Declaration

long mpiAxisFlashConfigGet(MPIAxis       axis,
                           void          *flash,
                           MPIAxisConfig *config,
                           void          *external)

Required Header

stdmpi.h

Description

AxisFlashConfigGet gets the flash configuration for an Axis (axis) and writes it into the structure pointed to by config, and also writes it into the implementation-specific structure pointed to by sexternal (if external is not NULL).

The Axis flash configuration information in external is in addition to the Axis 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).

	axis	a handle to the Axis object
	*flash
	*config	pointer to an MPIAxisConfig structure
	*external	pointer to an external. See remarks below.

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

Return Values
MPIMessageOK	if AxisEventNotifySet successfully requests host notification of the event(s) that are specified by eventMask and generated by motion

See Also	MEIFlash \| mpiAxisFlashConfigSet \|MEIAxisConfig