meiAxisFrameBufferStatus

Declaration

	long meiAxisFrameBufferStatus(MPIAxis axis, MEIAxisFrameBufferStatus *status);
	Required Header: stdmpi.h Change History: Added in the 03.04.00

Description

meiAxisFrameBufferStatus reads an axis’s frame buffer status and writes it into the structure pointed to by status.

axis	a handle to the Axis object.
status	a pointer to the frame buffer status structure returned by the method.

Return Values
MPIMessageOK
MPIMessageARG_INVALID
MPIMessageHANDLE_INVALID

Sample Code


void printAxisFrameBufferInfo(MPIAxis axis)
{
   MEIAxisFrameBufferStatus status;
   long returnValue = meiAxisFrameBufferStatus(axis,
                                               &status);
   msgCHECK(returnValue);

   printf(“Size of frame buffer: %d\n”, status.size);
   printf(“Number of remaining frames: %d\n”, status.frameCount);
   printf(“Number of free frames %d\n”,(status.size - status.frameCount)); 
}