acgsGetScreenShot

C++

AcGsScreenShot * acgsGetScreenShot(
    int viewportNumber
);

File

acgs.h

Description

This function returns a pointer to a new AcGsScreenShot for the viewport identified by viewportNumber. (This number is the same as the numbers reported by the CVPORT AutoCAD system variable. For example, the Paper Space viewport is number 1.) AcGsScreenShot objects are available for each individual viewport, and also for the special viewport "0", which encompasses all viewports. Screen shots are images of the drawing surface, and do not include overlayed items such as dialogs, pointers, or other windows.

If viewportNumber is not valid, NULL is returned.

The caller is responsible for deleting the returned AcGsScreenShot object.

For example:

AcGsScreenShot * pScreenShot;
pScreenShot = acgsGetScreenShot (0, pScreenShot);
...
delete pScreenShot;

Be careful when specifying "1" for the paper space viewport. You will get only the items that actually exist in paper space. To get all items, use "0".

Parameters