Category Assembly, Object ProRef

Function ProRefCtrlCheckScope


Description
Check if object-specific reference control settings for the specified model (independent object or assembly component) allow that model to reference information belonging to a different model. The top-level assembly for the component being modified and for the component being referenced must be the same.
Synopsis
#include <ProScope.h>
ProErrorProRefCtrlCheckScope(
ProSolid solid
/* (In)
Handle to solid (part or assembly) being modified. Must not be NULL.
*/
ProAsmcomppath* own_comp
/* (In)
Handle to path for component being modified (in context of its top assembly). Must not be NULL.
*/
ProSolid ref_solid
/* (In)
Handle to the solid being referenced. Must not be NULL.
*/
ProAsmcomppath* ref_comp
/* (In)
Handle to path for the component being referenced (in context of its top assembly). Must not be NULL.

NOTE:

The top assembly in own_comp and ref_comp must be the same. If the owner of own_comp is NULL and ref_solid is not a sub model or solid, then the reference is checked as an "Out of Assembly Context" reference. An example is references through relations.

*/
ProMdl* p_scope_owner
/* (Out)
Handle to solid that owns scope being violated. If NULL but there is a violation, then the environment scope setting is violated.
*/
)
Returns
PRO_TK_NO_ERRORNo scope violation, reference is allowed.
PRO_TK_E_FOUNDReference control violation found.
PRO_TK_BAD_INPUTSBad input arguments. Top assemblies in own_comp and in ref_comp are not the same.
PRO_TK_NOT_VALIDRequired license not found.
PRO_TK_GENERAL_ERRORThe check failed.

Manual References:

  1. Assembly: Top-down Design: External Reference Control Functions