API Documentation > Custom user interface > Object ProUIDialog > Function ProUIDialogComponentsCollect
Function ProUIDialogComponentsCollect
Description
Returns the names of components in this dialog. This function can also filter components by their type.
Synopsis
#include <ProUIDialog.h>
ProUIDialogComponentsCollect
(
char* dialog
/* (In)
Name of the dialog.
*/
char* component_type
/* (In)
One of the predefined component class types (see ProUI.h). Pass NULL to obtain all components.
*/
int* count
/* (Out)
The number of components found.
*/
char*** component_array
/* (Out)
The component array. Free this using ProStringarrayFree().
*/
)
Returns
The function succeeded.
One or more input arguments was invalid.
No components of the given type were found.
User Guide References
Was this helpful?