ImageGear for C and C++ on Linux v19.10 - Updated
IG_dspl_orientation_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_orientation_get

This function returns the current orientation mode.

Declaration:

 
Copy Code
AT_ERRCOUNT  ACCUAPI  IG_dspl_orientation_get( 
        [IN] HIGEAR hIGear, 
        [IN] DWORD dwGrpID,
        [OUT] LPAT_MODE lpnOrientMode
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of group from which to retrieve the orientation mode.
lpnOrientMode LPAT_MODE Where to copy OrientMode value. If NULL then this parameter ignored.

Return Value:

Returns 0 if successful. Otherwise, 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++.

Example:

 
Copy Code
HIGEAR            hIGear;       /* HIGEAR handle of image  */ 
DWORD           nGrpID;        /* display group identifier  */
AT_MODE          nOrientMode;      /* Orientation mode  */
 ...
IG_dspl_orientation_get( hIGear, nGrpID, &nOrientMode );
 ...

Remarks:

Possible values are listed in the IG_dspl_orientation_set() function.