Category Family table, Object ProFamtable

Function ProFamtableInstanceVisit


Description
Visits all the instances in a family table.
Replacement in Object TOOLKIT: pfcFamilyMember::ListRows
pfcFamilyMember::GetRow
Synopsis
#include <ProFaminstance.h>
ProErrorProFamtableInstanceVisit(
ProFamtable* p_famtab
/* (In)
The handle to the family table.
*/
ProFamtableInstanceAction visit_action
/* (In)
The action to perform on each instance. If it returns anything other than PRO_TK_NO_ERROR, visiting stops.
*/
ProFamtableInstanceFilter filter_action
/* (In)
The filter function. If NULL, all instances are visited using the action function.
*/
ProAppData app_data
/* (In)
The application data passed to the visiting and filter functions.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully visited all the instances.
PRO_TK_BAD_INPUTSOne or more inputs was invalid.
OtherAny other value is the value returned by the action function (visiting stopped).

Manual References:

  1. Core: Family Tables: Visiting Family Tables
  2. Core: Family Tables: Visiting Family Tables

Sample Code References:

  1. pt_examples ( UtilCollect.c )