Function

CFReadStreamGetBuffer

Returns a pointer to a stream’s internal buffer of unread data, if possible.

Declaration

const UInt8 * CFReadStreamGetBuffer(CFReadStreamRef stream, CFIndex maxBytesToRead, CFIndex *numBytesRead);

Parameters

stream

The stream to examine.

maxBytesToRead

The maximum number of bytes to read. If greater than 0, maxBytesToRead limits the number of bytes read; if 0 or less, all available bytes are read.

numBytesRead

On return, contains the length of returned buffer. If stream is not open or has encountered an error, numBytesRead is set to -1.

Return Value

A pointer to the internal buffer of unread data for stream, if possible; NULL otherwise. The buffer is good only until the next stream operation called on the stream. You should neither change the contents of the returned buffer nor attempt to deallocate the buffer; it is still owned by the stream. The bytes returned in the buffer are considered read from the stream.

See Also

Examining Stream Properties

CFReadStreamCopyProperty

Returns the value of a property for a stream.

CFReadStreamCopyError

Returns the error associated with a stream.

CFReadStreamGetError

Returns the error status of a stream.

CFReadStreamGetStatus

Returns the current state of a stream.

CFReadStreamHasBytesAvailable

Returns a Boolean value that indicates whether a readable stream has data that can be read without blocking.