ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Image Processing Functions / IG_IP_decrypt
In This Topic
    IG_IP_decrypt
    In This Topic

    This function decodes an image, or a rectangular portion thereof, that was encrypted using IG_IP_encrypt().

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_IP_decrypt ( 
            HIGEAR hIGear, 
            LPAT_RECT lpRect, 
            AT_MODE nEncryptType, 
            LPSTR lpszPassword 
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle of image to be decoded.
    lpRect LPAT_RECT Far pointer to an AT_RECT struct specifying the rectangular portion of the image to decode. Set = NULL for the whole image.
    nEncrptyType AT_MODE An IG_ENCRYPT_METHOD_ constant specifying how the image was encoded.
    lpszPassword LPSTR Far pointer to your zero-terminated password string.

    Return Value:

    Returns the number of ImageGear errors that occurred during this function call.

    Supported Raster Image Formats:

    All pixel formats supported by ImageGear for C and C++.

    Sample:

    FlashPix

    Example:

     
    Copy Code
    HIGEAR hIGear;
    /* Decrypt the whole hIGear image by method A & with "Top Secret" password   */ 
    IG_IP_decrypt (hIGear, NULL, IG_ENCRYPT_METHOD_A, "Top Secret");
    

    Remarks:

    This function works on a DIB, not on a file. You must supply both the encryption method and the password that were used in the call to IG_IP_encrypt().