Category Family table, Object ProFaminstance

Function ProFaminstanceFamtableItemIsDefault


Description
Determines if the value of the specified item for the specified instance is the default value.
Replacement in Object TOOLKIT: pfcFamilyMember::GetCellIsDefault
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceFamtableItemIsDefault(
ProFaminstance* p_inst
/* (In)
The instance handle.
*/
ProFamtableItem* p_item
/* (In)
The family table item
*/
ProBoolean* is_default
/* (Out)
This is PRO_B_TRUE, if the instance has default value for specified item.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSOne or more of the input arguments are invalid.
PRO_TK_E_NOT_FOUNDThe specified instance does not exist in the family table, or the specified model item is not table-driven.
PRO_TK_GENERAL_ERRORA general error occurred and the function failed (for example, the function could not find the family table, or the generic model).

Manual References:

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