Category Family table, Object ProFaminstance

Function ProFaminstanceRetrieve


Description
Retrieves an instance of a model from disk.
Replacement in Object TOOLKIT: wfcWFamilyTableRow::GetModelFromDisk
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceRetrieve(
ProFaminstance* p_inst
/* (In)
The instance to retrieve.
*/
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 model.
PRO_TK_E_NOT_FOUNDThe specified instance model was not found on disk.
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 ( TestFamTab.c )
  3. pt_examples ( TestCavityLayout.c )
  4. pt_userguide ( UgInterfaceExport.c )
  5. pt_wc_server ( PTWCServerAddInstance.c )