iDRS™ SDK 16
Loading...
Searching...
No Matches
CImageSaveOptions_interface.h File Reference

Interface for CImageSaveOptions wrapper. More...

Go to the source code of this file.

Functions

CImageSaveOptions CImageSaveOptions_Create (enum ImageFormat const evImageFormat, idrs_exception *pargException)
 Creates a new instance of CImageSaveOptions and initializes it with the supplied image format.
 
enum ImageFormat CImageSaveOptions_GetImageFormat (const CImageSaveOptions argCImageSaveOptions, idrs_exception *pargException)
 Get the image format.
 
void CImageSaveOptions_Destroy (CImageSaveOptions argCImageSaveOptions, idrs_exception *pargException)
 Destroys a CImageSaveOptions handle.
 

Detailed Description

Interface for CImageSaveOptions wrapper.

Function Documentation

◆ CImageSaveOptions_Create()

CImageSaveOptions CImageSaveOptions_Create ( enum ImageFormat const  evImageFormat,
idrs_exception *  pargException 
)

Creates a new instance of CImageSaveOptions and initializes it with the supplied image format.

Parameters
evImageFormatThe image format
pargExceptionPointer to exception structure that will be filled if an exception occurs
Returns
The newly created CImageSaveOptions object

◆ CImageSaveOptions_Destroy()

void CImageSaveOptions_Destroy ( CImageSaveOptions  argCImageSaveOptions,
idrs_exception *  pargException 
)

Destroys a CImageSaveOptions handle.

Parameters
argCImageSaveOptionsCImageSaveOptions handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CImageSaveOptions_GetImageFormat()

enum ImageFormat CImageSaveOptions_GetImageFormat ( const CImageSaveOptions  argCImageSaveOptions,
idrs_exception *  pargException 
)

Get the image format.

Returns
The image format.
Parameters
argCImageSaveOptionsCImageSaveOptions handle
pargExceptionPointer to exception structure that will be filled if an exception occurs