ImageGear for C and C++ on Linux v20.0 - Updated
IG_PDF_stream_read
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_STREAM > IG_PDF_stream_read

Creates a read-only PDF stream from an arbitrary data-producing procedure.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_stream_read(
        HIG_PDF_STREAM hStream,
        LPSTR lpBuffer,
        LONG nItems,
        SHORT nItemSize,
        LPLONG lpnItemsRead 
);

Arguments:

Name Type Description
hStream HIG_PDF_STREAM The stream from which data is read.
lpBuffer LPSTR Buffer into which data is written.
nItems LONG Number of items to read. The amount of data read into the memory buffer will be nItems ? nItemSize, unless an EOF is encountered first. The relative values of nItems and nItemSize really do not matter; the only thing that matters is their product. It is often convenient to set nItemSize to 1, so that nItems is the number of bytes to read.
nItemSize SHORT Number of bytes in an item in the stream.
lpnItemsRead LPLONG The number of items (not bytes) read.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The stream is not seek-able. lpfnReadProc is called when the client of the stream attempts to read data from it.

Is this page helpful?
Yes No
Thanks for your feedback.