Returns a pointer to a stream’s internal buffer of unread data, if possible.
SDKs
- iOS 2.0+
- macOS 10.1+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Core Foundation
Declaration
const UInt8 * CFReadStreamGetBuffer(CFRead Stream Ref stream, CFIndex maxBytesToRead, CFIndex *numBytesRead);
Parameters
stream
The stream to examine.
maxBytesToRead
The maximum number of bytes to read. If greater than
0
,max
limits the number of bytes read; ifBytes To Read 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,num
is set toBytes Read -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.