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>
ProUIDashboardpageComponentnameGet | |
( 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
The function succeeded. | |
One or more input arguments was invalid. | |
The component by this name was not found in the page. |
Sample Code References
User Guide References