ReadFile

Reads an image file into a pixmap.

GSErrCode ReadFile (
        const IO::Location&    fileLoc,
        GSPixMapHandle*                pixHdl,
        GSPixelType            outputFormat
);

Parameters

fileLoc

The location of the image file.

pixHdl

The address of the destination pixmap.

outputFormat

The desired pixel type of the destination pixmap.

Return values

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

Remarks

The destination pixmap handle should be NULL-initialized.

Requirements

Version:

GX

Header:

GXImageBase.hpp

Import Library:

GXImageBase.lib

Module:

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

See Also

GXImageBase