ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / PDF Component API Reference / PDF Component Objects Reference / Basic Objects / HIG_PDF_BASSTREAM / IG_PDF_basstream_create
In This Topic
    IG_PDF_basstream_create
    In This Topic

    Creates a new stream object associated with the specified document and having the specified value.

    Declaration:

     
    Copy Code
    AT_ERRCOUNTACCUAPI IG_PDF_basstream_create(
            HIG_PDF_DOC hDoc,
            HIG_PDF_STREAM hStream,
            AT_PDF_BOOL bEncodeTheSourceData,
            HIG_PDF_BASOBJ hAttributesDictionary,
            HIG_PDF_BASOBJ hEncodeParameters,
            LPHIG_PDF_BASOBJ lphBasStream
    );
    

    Arguments:

    Name Type Description

    hDoc

    HIG_PDF_DOC

    The document in which the object is used.

    hStream

    HIG_PDF_STREAM

    The source stream containing the data to copy into the new stream.

    bEncodeTheSourceData

    AT_PDF_BOOL

    Determines whether the data in stm should be encoded using filters specified in hAttributesDictionary.

    hAttributesDictionary

    HIG_PDF_BASOBJ

    Either the NULL, or a dictionary containing stream attributes, such as the length of the stream data and a list of decoding filters, as defined in Section 3.2.7 in the PDF Reference. 

    hEncodeParameters

    HIG_PDF_BASOBJ

    The parameters to be used by the encoding filters.

    lphBasStream

    LPHIG_PDF_BASOBJ

    The value the new stream will have.

    Return Value:

    Error count.