ImageGear for C and C++ on Windows v19.6 - Updated
IG_PDF_basstr_create
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Basic Objects > HIG_PDF_BASSTR > IG_PDF_basstr_create

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

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_basstr_create(
        HIG_PDF_DOC hDoc,
        AT_PDF_BOOL bIndirect,
        LPBYTE lpString,
        LONG nBytes,
        LPHIG_PDF_BASOBJ lphString 
);

Arguments:

Name Type Description
hDoc HIG_PDF_DOC The document in which the object is used.
bIndirect AT_PDF_BOOL If TRUE, creates the string as an indirect object, i.e., the object won't be directly inserted when added to a dictionary or array. If FALSE, creates the string as a direct object, i.e., the object will be inserted into any dictionary or array to which it is added.
lpString LPBYTE The value the new string will have.
nBytes LONG The length of lpString.
lphString LPHIG_PDF_BASOBJ The handle of the new string.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.