CF2 API Reference (PDF) - Persistor Instruments Inc

CF2 API ReferencePing-Pong Buffer FunctionsSummary of Ping-Pong Buffer FunctionsPPBCheckRdAvailPPBCheckWrFreePPBClosePPBFlushPPBGetMemBufPPBOpenPPBPutBytePPBPutWordPPBReadPPBWriteReturn the number of bytes waiting to be readReturn the free space left before a wrapClose a ping-pong buffer (does not automatically flush)Flush a ping-pong buffer and force a ping-pong flipReturn the read buffer and optionally zero the sizeOpen and initialize a ping-pong bufferWrite 8-bit byte into the ping-pong bufferWrite 16-bit word into the ping-pong bufferRead data from the ping-pong bufferWrite data into the ping-pong bufferPPBCheckRdAvail -- Return the number of bytes waiting to be readDescription:Prototype:Inputs:Returns:Return the number of bytes waiting to be readlong PPBCheckRdAvail(void *ppb);ppb is the generic pointer returned by PPBOpen and used internally to manage the buffers.Returns the count of available bytes in the read bufferPPBCheckWrFree -- Return the free space left before a wrapDescription:Prototype:Inputs:Returns:Return the free space left before a wraplong PPBCheckWrFree(void *ppb);ppb is the generic pointer returned by PPBOpen and used internally to manage the buffers.Returns the number of bytes that can be written before the buffer ping-pongsPPBClose -- Close a ping-pong buffer (does not automatically flush)Description:Prototype:Inputs:Returns:Close a ping-pong buffer (does not automatically flush)void PPBClose(void *ppb);ppb is the generic pointer returned by PPBOpen and used internally to manage the buffers.Returns nothingPERSISTORInstruments Inc.35 of 84CF2 API Reference7/19/2005