Category Family table, Object ProFaminstance

Function ProFaminstanceLock


Description
Locks or unlocks the specified instance.
Replacement in Object TOOLKIT: pfcFamilyTableRow::IsLocked
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceLock(
ProFaminstance* p_inst
/* (In)
The instance handle.
*/
int lock_it
/* (In)
If this is TRUE, lock the instance; otherwise, unlock it.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully locked or unlocked the instance.
PRO_TK_E_NOT_FOUNDThe specified instance does not exist in the family table.
PRO_TK_GENERAL_ERRORA general error occurred and the function failed (for example, the generic does not exist in session, or the function could not find the family table).

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 )