Category Creo Parametric user interface, Object ProUIDashboardpage

Function ProUIDashboardpageComponentnameGet


Description
Obtains the real component name in the dashboard page. This name should be used in ProUI functions for accessing a component in the dashboard.
Synopsis
#include <ProUIDashboard.h>
ProErrorProUIDashboardpageComponentnameGet(
ProUIDashboardPage page
/* (In)
The dashboard page handle.
*/
char* nominal_name
/* (In)
The nominal component name from the resource file used to generate this page. To get the name of the top-most layout for the page, pass "".
*/
char** component_name
/* (Out)
The true component name to use for this instance of the dashboard page. Free this string using ProStringFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_E_NOT_FOUNDThe component by this name was not found in the page.

Manual References:

  1. User Interface: Dashboards: Accessing Components in the Dashboard Pages

Sample Code References:

  1. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  2. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  3. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  4. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  5. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  6. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  7. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  8. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  9. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  10. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  11. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  12. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  13. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  14. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  15. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  16. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  17. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  18. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  19. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  20. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  21. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  22. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  23. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  24. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  25. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  26. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )
  27. pt_userguide ( UgCreoSweepCreate.c )
  28. pt_userguide ( UgCreoSweepCreate.c )
  29. pt_userguide ( UgCreoSweepCreate.c )
  30. pt_userguide ( UgCreoSweepCreate.c )
  31. pt_userguide ( UgCreoSweepCreate.c )
  32. pt_userguide ( UgCreoSweepCreate.c )
  33. pt_userguide ( UgCreoSweepCreate.c )
  34. pt_userguide ( UgCreoSweepCreate.c )
  35. pt_userguide ( UgCreoSweepCreate.c )
  36. pt_userguide ( UgCreoSweepCreate.c )
  37. pt_userguide ( UgCreoSweepCreate.c )
  38. pt_userguide ( UgCreoSweepCreate.c )