Category Family table, Object ProFaminstance

Function ProFaminstanceMdlGet


Description
Retrieves the handle to the instance model, if it is in session.
Replacement in Object TOOLKIT: wfcWFamilyTableRow::GetModelFromSession
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceMdlGet(
ProFaminstance* p_inst
/* (In)
The handle to the instance.
*/
ProMdl* pp_model
/* (Out)
The handle to the instance model. You must allocate the space for this argument.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the handle.
PRO_TK_E_NOT_FOUNDThe specified instance model is not in session.
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 )