C++ Syntax

MKI_ENTITY_BLOCK_PTR

MKI_CalcBlockFrame(

const LPCWSTR f_pszBlockName,

const LPCWSTR f_pszLibraryName,

MKI_CONST_MATRIX_PTR f_pMatrix,

MKI_RECT_PTR f_rFrame,

bool f_fAutoLoad );

Calculates the surrounding frame of a block, and returns its address if possible.

This procedure can be used to check whether a specific block is available. In this case, set both Matrix and Frame to nullptr. If you only need to check whether a block is already in memory, set AutoLoad to false. If you want to check whether a block is available in any of the currently listed libraries (whether loaded or not), set AutoLoad to true.

Parameters

BlockName

[const LPCWSTR] Name of the block whose surrounding frame is to be calculated.

LibraryName

[const LPCWSTR] Name of the library the block is located in.

Matrix

[MKI_CONST_MATRIX_PTR] Matrix with which the block is to be temporarily multiplied before calculating the surrounding frame. If nullptr, no temporary modification is performed. The block itself will never be modified!

Frame

[MKI_RECT_PTR] Address of a rectangle buffer to receive the calculated surrounding frame. If nullptr, the frame will not be calculated. The coordinates are sorted, i.e. x1 ≤ x2 and y1 ≤ y2.

AutoLoad

[bool] This parameter determines whether or not the specified block is to be loaded into the cache or not. If false, the return value of MKI_CalcBlockFrame can be used to determine whether the specified block is already in the cache or not.

Please be aware that setting AutoLoad to true can result in the time-consuming process of scanning the complete library and loading that block into the cache. So avoid this option unless you really need to load that block into memory!

Return Value

Returns the address of the block if successful. If nullptr is returned, the rectangle pointed to by Frame is not modified.