Category Family table, Object ProFaminstance

Function ProFaminstanceImmediategenericinfoGet


Description
Retrieves the name and model type of the immediate generic model.
Replacement in Object TOOLKIT: pfcModel::GenericName
pfcFamilyMember::GetImmediateGenericInfo
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceImmediategenericinfoGet(
ProMdl inst_model
/* (In)
The handle to the instance model.
*/
ProName gen_name
/* (Out)
The name of the immediate generic model.
*/
ProMdlType* p_gen_type
/* (Out)
The model type of immediate generic model. If the function fails, this is set to PRO_TYPE_UNUSED.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the name and model type.
PRO_TK_E_NOT_FOUNDThe specified model is not an instance -- it has no generic model.
PRO_TK_GENERAL_ERRORThe function failed.

Manual References:

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