mpiAxisConfigGet

Declaration

long mpiAxisConfigGet(MPIAxis       axis,
                      MPIAxisConfig *config,              
                      void          *external)

Required Header

stdmpi.h

Description

AxisConfigGet gets the configuration of 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 external (if external is not NULL).

The configuration information in external is in addition to the configuration information in config, i.e, the 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
	*config	pointer to the 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.

Return Values
MPIMessageOK	if AxisConfigGet successfully gets the Axis configuration and writes it into the structure(s)

See Also	MPIAxisConfig \| mpiAxisConfigSet \| MEIAxisConfig