Category Family table, Object ProFaminstance

Function ProFaminstanceIsExtLocked


Description
Determines whether the specified instance exists in the family table and, if it exists, returns its lock status by external application.
Replacement in Object TOOLKIT: pfcFamilyTableRow::IsExtLocked
Synopsis
#include <ProFaminstance.h>
ProErrorProFaminstanceIsExtLocked(
ProFaminstance* p_inst
/* (In)
The instance handle.
*/
ProBoolean* locked
/* (Out)
The external lock status. If this is TRUE, the instance is locked by external application.
*/
)
Returns
PRO_TK_NO_ERRORThe instance exists, and the function successfully returned its external lock status.
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