In This Topic ▼

LINEREMOVECALLBACK

Summary

Handles each line found by L_LineRemoveBitmap.

Syntax

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction (hRgn, iStartRow, iStartCol, iLength, pUserData)

Parameters

HRGN hRgn

Windows region representing a line to be removed. It is the programmers responsibility to delete this region, using DeleteObject() when it is no longer needed.

L_INT iStartRow

The starting row of the line. The rows are zero-based.

L_INT iStartCol

The starting column of the line. The columns are zero-based.

L_INT iLength

Length (in pixels) of the line.

L_VOID* pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_LineRemoveBitmap)

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

Value	Meaning
SUCCESS_REMOVE	Remove the line.
SUCCESS_NOREMOVE	Do not remove the line.
Otherwise	An error occurred. Refer to Return Codes.

Comments

The callback is called for each line found. Return SUCCESS_REMOVE to have the line removed. Return SUCCESS_NOREMOVE to leave the line unchanged. Pass any other value to abort. This value will be the return value of the L_LineRemoveBitmap(). If flags LINE_IMAGE_UNCHANGED and LINE_SINGLE_REGION are being used, then the return value of the callback affects the internal single region that contains all the changes.