mpiAxisFrameBufferStatus

Declaration

int32_t  mpiAxisFrameBufferStatus(MPIAxis                    axis,
                               MPIAxisFrameBufferStatus   *status);

Required Header: axis.h
Change History: Added in the 03.04.00

Description

mpiAxisFrameBufferStatus 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)
{
   MPIAxisFrameBufferStatus status;
   int32_t returnValue = mpiAxisFrameBufferStatus(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)); 
}

See Also

MPIAxisFrameBufferStatus