Category External objects, Object ProExtobj

Function ProExtobjVisit


Description
Performs an action on several external objects.
Synopsis
#include <ProExtobj.h>
ProErrorProExtobjVisit(
ProMdl model
/* (In)
The handle to the model.
*/
ProExtobjClass* extobjclass
/* (In)
The handle to the external object class.
*/
ProExtobjVisitAction visit_action
/* (In)
The action to perform on each external object. If the function returns anything other than PRO_TK_NO_ERROR, visiting ends.
*/
ProExtobjFilterAction filter_action
/* (In)
The filter function. If NULL, all external objects are visited using the action function.
*/
ProAppData app_data
/* (In)
The application data passed to the visiting and action functions.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully visited all the parameters.
PRO_TK_E_NOT_FOUNDThe function could not find the needed objects.
PRO_TK_BAD_INPUTSOne or more of the input arguments are invalid.
PRO_TK_BAD_CONTEXTThe owner was not found.
OtherThe action function returned an error.

Manual References:

  1. Event-driven Programming: External Objects: Visiting External Objects

Sample Code References:

  1. pt_examples ( UtilCollect.c )