MatrixObject::SetLeadBitmap

SetLeadBitmap

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

Set the LEAD bitmap handle of the matrix object.

Syntax

BOOL SetLeadBitmap( LPVOID pLBmp, BOOL bMakeCopy = true, BOOL bResetZoom = false )

Parameters

pLBmp: [input] pointer to the LEAD bitmap to set into the matrix object
bMakeCopy: [input] flag to indicate if a copy of the LEAD bitmap should be set into the matrix object.; true(by default) to set, false to not.
bResetZoom: [input] true will reset view to full page, false(by default) will keep current zoom setting

Return

Return TRUE for success and FALSE for error.

Examples

EX1

void    MatrixObject_SetLeadBitmap_Ex1(LPVOID pLBmp)
{
    MatrixPage mp = Project.MatrixPages(0);
    if(!mp)
        return;
    
    MatrixObject mo(mp.GetName(), 0);
    if(!mo.SetLeadBitmap(pLBmp))
        printf("failed to set");
}