Category Creo Parametric user interface, Object ProUIDashboard

Function ProUIDashboardStdlayoutButtonAdd


Description
Adds a new push button to the dashboard of Creo Parametric. This function affects the top-level Creo Parametric dashboard only. This function is executed only once during a Creo Parametric session for each push button. Subsequent calls to this function for a previously loaded push button are ignored.
Synopsis
#include <ProUIDashboard.h>
ProErrorProUIDashboardStdlayoutButtonAdd(
ProUIDashboardPage page_handle
/* (In)
Handle to the dashboard page.
*/
ProUIDashboardButtonLabel button_label
/* (In)
The label of the push button
*/
ProUIDashboardButtonHelp one_line_help
/* (In)
The one-line help for the push button
*/
ProFileName filename
/* (In)
The name of the message file that contains the label and help string
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully added the button.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed to add the button.
PRO_TK_MSG_NOT_FOUNDThe specified message was not found in the message file.

Manual References:

  1. User Interface: Dashboards: Accessing a Dashboard Page
  2. User Interface: Dashboards: Accessing a Dashboard Page