IG_REC_converter_picture_saving_mode

Returns value indicating how the pictures are saved in the output document.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_picture_saving_mode_get( LPCSTR lpszFormatName, enumIGRecPictureSavingMode* lpPictures );

Arguments:

Name	Type	Description
lpszFormatName	LPCSTR	Symbolic name of the output format like Converters.Text.Cvs.
lpPictures	enumIGRecPictureSavingMode*	Buffer to retrieve the enumIGRecPictureSavingMode enumeration value indicating how the picture is saved in the output document.

Return Value:

The number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

	Copy Code
AT_ERRCOUNT ErrCount = 0; AT_BOOL bCPSMIsApplicable = FALSE; LPCSTR lpszFormatName = "Converters.Text.Csv"; enumIGRecPictureSavingMode ePictureSavingMode = IG_REC_PICTURES_SAVE_NONE; ErrCount += IG_REC_output_format_set(lpszFormatName); ErrCount += IG_REC_converter_picture_saving_mode_is_applicable(lpszFormatName, &bCPSMIsApplicable); if(bCPSMIsApplicable) ErrCount += IG_REC_converter_picture_saving_mode_get(lpszFormatName, &ePictureSavingMode);

Copy Code

AT_ERRCOUNT ErrCount = 0;
AT_BOOL bCPSMIsApplicable = FALSE;
LPCSTR lpszFormatName = "Converters.Text.Csv";
enumIGRecPictureSavingMode ePictureSavingMode = IG_REC_PICTURES_SAVE_NONE;

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_picture_saving_mode_is_applicable(lpszFormatName,
    &bCPSMIsApplicable);
if(bCPSMIsApplicable)
    ErrCount += IG_REC_converter_picture_saving_mode_get(lpszFormatName,
        &ePictureSavingMode);

Remarks:

See IG_REC_converter_picture_saving_mode_set for formats that support this setting.

Picture saving mode can't be retrieved if the corresponding output format has not been selected with IG_REC_output_format_set at least once. In this case the function returns a non-zero value and appends IGE_REC_CONVERTER_NOT_INITIALIZED error code to the error stack.