acgsSetCustomUpdateMethod

C++

Adesk::Boolean acgsSetCustomUpdateMethod(
    acgsCustomUpdateMethod custom_update_method, 
    void * pParm
);

File

acgs.h

Description

This function sets the function pointed to by custom_update_method to be called after AutoCAD has updated its long-term graphics (all persistent geometry), but before the short-term graphics (blips, grips, cursor, icon, highlights, and so on) are updated. This allows an application to draw graphics that will not be overwritten by AutoCAD's longterm graphics.

Only a single application at a time can take advantage of this functionality. This means that this function will only succeed in setting custom_update_method as the callback if there is no other callback function currently registered.

A callback function should unregistered as soon as it is no longer needed. To do so, this function should be called a second time with the same custom_update_method value as was used to originally register the callback function.

The pParam pointer will be passed as the first argument to the custom_update_method callback function each time the callback function is executed.

Returns true if the callback function is successfully set; otherwise, returns false.

Parameters