formZ SDK | 4.0 Call Back Reference | File Translator | Structured File Translator | Image Bitmap Call Back

# fz_ffmt_cbak_image_bmap_read

Description

Reads a bitmap file. This function is called to get pixel data stored in a bitmap file.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_image_bmap_read(

fzrt_int | windex,
fz_ffmt_ref_td | ffmt_id,
fzrt_floc_ptr | floc,
fz_ffmt_image_channel_enum | which_channel,
fzrt_pbuf_ptr * | pbuf )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

floc [Input]

The file to read from.

which_channel [Input]

Which channels of the image to read.

pbuf [Result]

A pixel buffer to fill with the bitmap's pixels.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_cbak_image_fset

Defined in

fz_ffmt_api.h