Category Family table, Object ProFaminstance

Function ProFaminstanceGenericGet


Description
Retrieves the generic model, given its handle.
Replacement in Object TOOLKIT: pfcModel::GenericName
pfcFamilyMember::Parent
pfcFamilyMember::GetTopGenericInfo
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceGenericGet(
ProMdl inst_model
/* (In)
The handle to the instance model.
*/
int immediate
/* (In)
If you set this to TRUE, the system searches for the immediate generic. If this is FALSE, the system searches for the top-level generic.
*/
ProMdl* gen_model
/* (Out)
The handle to the top-level or immediate generic model.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the handle.
PRO_TK_E_NOT_FOUNDThe specified model is not an instance -- it has no generic model.
PRO_TK_CANT_OPENThe immediate generic is not in session ('immediate' is set to TRUE). Use ProFaminstanceImmediategenericinfoGet() to obtain the name and modeltype of immediate generic in such case.
PRO_TK_GENERAL_ERRORA general error occurred and the function failed.

Manual References:

  1. Core: Family Tables: Operations on Family Table Instances
  2. Core: Family Tables: Operations on Family Table Instances

Sample Code References:

  1. pt_examples ( TestFamTab.c )
  2. pt_examples ( TestCavityLayout.c )
  3. pt_userguide ( UgDrawingSolidReplace.c )
  4. pt_userguide ( UgFamtabUse.c )
  5. pt_wc_server ( PTWCServerPartToPView.c )