ImageGear for C and C++ on Linux - Updated
IG_display_animation_delay_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_display_animation_delay_get

This function obtains the animation delay setting for image hIGear, as set by IG_display_animation_delay_set().

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_display_animation_delay_get ( 
        HIGEAR hIGear, 
        LPUINT lpDelay 
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle of image.
lpDelay LPUINT Far pointer to a UINT variable to receive current animation delay setting for this image.

Return Value:

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

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
HIGEAR            hIGear;                /* HIGEAR handle of image                                                  */
UINT             nDelay;                /* Will hold returned Delay setting                                          */
IG_display_animation_delay_get ( hIGear, &nDelay );

Remarks:

ImageGear does not provide functions for creating animation. This function is for getting this value from the HIGEAR. You will need to write your own code to display the images in succession (animate).