Functions > CurrentLayoutCAD

The CurrentLayoutCAD returns handle of the layout specified by nIndex and can redraw this layout.

Syntax:

HANDLE CurrentLayoutCAD(

HANDLE hObject, // handle of the application main window

int nIndex, // defines the number of the necessary layout

bool bDoChange,

);

Parameters:

hObject

Identifies the opened CAD Image drawing object handle.

nIndex

Specifies the hObject index in the layout table. Its value should be no greater than or equal to zero and less than or equal to the value returned by CADLayoutCount minus 1.

bDoChange

Specifies whether the current layout has to be redrawn.

If bDoChange is set to TRUE, then will be displayed layout specified by nIndex.

If bDoChange is set to FALSE, no changes happens.

Return Value:

If the function succeeds, the return value is a handle of the layout specified by nIndex.

If the function fails, the return value is NULL. To get extended error information, call GetLastErrorCAD.

Note:

It is recommended to use the CADLayoutsCount function before calling the CurrentLayoutCAD function.