IC Imaging Control C++

saveToFileBMP Method

saveToFileBMP Method

This function saves the contents of an image buffer to a .BMP file.
Syntax:
Error saveToFileBMP( const IFrame& buf, const std::string& filename );
Error saveToFileBMP( const IFrame& buf, const std::wstring& filename );
Error saveToFileBMP( const IFrame& buf, const wchar_t* pFilename );

Error saveToFileBMP( const IFrame& buf, const std::string& filename, tColorformatEnum file_fmt );
Error saveToFileBMP( const IFrame& buf, const std::wstring& filename, tColorformatEnum file_fmt );
Error saveToFileBMP( const IFrame& buf, const wchar_t* pFilename, tColorformatEnum file_fmt );

Parameter Description
buf

The buffer that is to be saved.

filename

Specifies the filename of the .BMP file.

pFilename

Specifies the filename of the .BMP file.

file_fmt

Specifies the color format of the .BMP file.

Return value:

This method returns an error object. On success, it is set to eNOERROR. If the conversion fails, eINVALID_PARAM_VAL is returned.

Remarks:

This method saves the contents of the passed IFrame into a .BMP file. If no file_fmt parameter is given, the format of the bitmap file (BITMAPINFO) is specified by the IFrame. If file_fmt is set and it differs from the color format currently set in IFrame, the contents are converted on the fly. This conversion may take awhile.

Information:

Introduced in version 2.0

See also: IFrame, MemBuffer, saveToFileJPEG, saveToFileTIFF, tColorformatEnum

<< Functions

Get in touch with us


About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

Automated Imaging Association ISO 9001:2015 certified

Contact us