C++ Syntax

bool

MKI_BitmapReadFromFile(

const LPCWSTR f_pszFileName,

MKI_FILENAMEW& f_rLocalName,

bool f_fEmbedded );

Reads a bitmap file from disk and adds it to the list of embedded or referenced bitmaps of the current drawing.

Please note that it is not necessary to load a referenced bitmap since this will be done automatically by the serving application as soon as required. You may, however, load them explicitly if you need information about that bitmap at an earlier time (e.g. during import).

Parameters

FileName

[const LPCWSTR] File name of a valid bitmap file. The maximum size of such a bitmap is 32,000 by 32,000 pixels, using color depths of 1 bit, 4 bit, 8 bit or 24 bit. For a list of currently supported bitmap file formats, please refer to the application’s user’s manual.

LocalName Changed in Version 6.32

[MKI_FILENAMEW&] Address of buffer to receive the resulting bitmap's name. If Embedded is true, this will be a unique identifier of the bitmap which can be used for further reference (e.g. in a MKI_BITMAPREF structure). If Embedded is false, this will be the local file name at which this bitmap was found by the file find procedure.

Embedded New in Version 6.32

[bool] If true, the bitmap will be marked as "embedded", i.e. it will be saved along with the drawing. If false, the bitmap will only be loaded temporarily and will be removed as soon as no more reference to it exists.

Return Value

Returns true if successful. If false is returned, either the parameters are invalid or the bitmap file could not be loaded (possibly due to insufficient memory).