Set title for process in History Palette from C++ plugin

[rechmbrs]

How does one set the title for process in History Palette from C++ plugin?  I wish to place something so that user can ID specific execution of a plugin.

Thanks,

RONC

[Tom Ruark · Accepted solution]

See SuspendHistory in PIActions.h. Only allowed from an automation plug-in. The other plug-in types gets the history entry the same as the menu entry.

/**

* Suspends recording of events to the History Palette for a given document, then invokes

* a plug-in callback function. Once the callback function returns, history recording is

* re-enabled, and a final state is added to the History Palette with the label provided

* in \c operationName.

* @param reference Reference to a document, or something contained in one. The plug-in must build

* the reference by using the @ref PicaActionReferenceSuite.

* @param proc The plug-in callback function, which plays actions that are not recorded.

* @param procData Data passed through to \c proc.

* @param operationName Final state added to the History Palette once \c proc completes, and

* history recording is resumed.

* @returns Non-zero error if failure.

*/

SPAPI OSErr (*SuspendHistory)(PIActionReference reference, PISuspendProc proc, void* procData, ASZString operationName);

[rechmbrs]

Tom,

Looked familiar as I found we use this in all of our scripts to hide the History palette.  The renaming part should be available for all plugin types as the one we have is a filter plugin and wanted to show parameters as well as plugin title.  Anything to help the user should be general purpose.

Thanks,

RONC