Function ProParameterVisit
Description
Performs a user-defined action on each parameter. Note: This function does not visit mass properties parameters.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProParameter.h>
ProParameterVisit | |
( ProModelitem* owner /* (In) The owner of the parameters. For model parameters use the function ProMdlToModelitem. */ ProParameterFilter filter /* (In) The filter function. If NULL, all parameters are are visited using the action function. */ ProParameterAction action /* (In) The action to perform on each ProParameter. If the function returns anything other than PRO_TK_NO_ERROR, visiting ends. */ ProAppData data /* (In) The application data passed to the filter and action functions. */ ) |
Returns
The function successfully visited all the parameters. | |
One or more of the input arguments are invalid, or the action function is PRO_NO_FUNCTION. | |
The owner was not found. | |
No parameters were found. | |
Other | Any other value is the value returned by the action function (visiting stopped). |
Sample Code References
User Guide References