WriteFile

Writes an image file from the pixmap.

GSErrCode WriteFile (
      const IO::Location&      fileLoc,
      const FTM::TypeID&       fileType,
      GSPixMapHandle           pixHdl,
      short                    pixelDepth,
      GSHandle                 optionsHandle
);

Parameters

fileLoc

The location of the target file.

fileType

The desired image format.

pixHdl

The pixmap to be written.

pixelDepth

The desired pixel size in bits in the target.

optionsHandle

A data-stream given back by the SetCompressionSettings function. Default value is NULL.

Return Values

If the function succeeds, the return value is NoError. If the function fails, the return value is the error code.

Remarks

If you supply an optionsHandle, the pixelDepth parameter is ignored. The optionsHandle should be made for the given targetFormat.

Requirements

Version:

GX

Header:

GXImageBase.hpp

Import Library:

GXImageBase.lib

Module:

GXImageBase.dll [WIN], GXImageBase.framework [MAC]

See Also

GXImageBase